dolfin team mailing list archive

[Anders Logg <logg@xxxxxxxxx>]

On Tue, Feb 01, 2011 at 03:02:23PM +0000, Garth N. Wells wrote:
> I would like to suggest that we rename the Python demos in a similar way
> to what we've done for C++ demo executables, e.g.
>
>   poisson/demo.py -> poisson/poisson-demo.py
>
> On reason for this is compatibility with the documentation system. At
> the moment, the documentation system appends a number to each 'demo.py'
> file to distinguish it from other demo files. This is really confusing
> because the number will, in general, different from the section number
> in the docs, e.g.
>
>   1. Poisson demo  (file: demo6.py)
>   . . .
>   6. Some other demo X (file: demo2.py)
>   7. Some other demo Y (file: demo1.py)
>
> Garth

Sounds good, but should we swap the prefix and postfix?

  demo-poisson.py

That makes it easier to run demos ('d' + tab completion).

We might also consider

  demo_poisson.py

since that works better if with Python import. (Not that we would want
to import the demos but '_' is in general a better naming scheme than
'-' for Python.) To be consistent, we would name the C++ demos
similarly.

--
Anders