fenics team mailing list archive

[Anders Logg <logg@xxxxxxxxx>]

On Tue, Apr 27, 2010 at 02:52:37PM +0200, Kristian Oelgaard wrote:
>
>
> On 27 April 2010 14:18, Anders Logg <logg@xxxxxxxxx> wrote:
> >Any ideas on how to keep the code in the documentation and the actual
> >demos in sync? Should we have a script that copies all the source
> >files? Or should we do the opposite: extract the demos from the
> >documentation?
>
> Good question, initially I thought copying from DOLFIN to documentation was the way to go, but on second thought the other  way around might be better.
> The reason is that if the demos break, then they will be fixed in the documentation which makes is more likely that the accompanying text (and code snippets) will also be corrected.
>
> Kristian

Yes, that might be the best option, to have a script that generates
the tree of demos from the documentation. The problem of course is
that there will be a higher threshold for developing demos but maybe
that is a good thing (if it means better demos and documentation).

--
Anders

Attachment: signature.asc
Description: Digital signature