dolfin team mailing list archive

[Kristian Ølgaard <k.b.oelgaard@xxxxxxxxx>]

On 31 August 2010 12:16, Anders Logg <logg@xxxxxxxxx> wrote:
> Is the idea that we should use these as starting points and then
> modify them when needed?

Yes, I'll start creating stubs for the Python programmer's reference
which will use autodoc to extract the documentation from the
dolfin/site-packages/dolfin/docstrings module.

> Will we generate them again later when we have improved the C++
> documentation?

I thought about it, but it will be an absolute nightmare since some
functions are renamed and because of the overloaded functions.

The syntax for examples is also different, we could store these in a
different place and add them later but then we'll have to figure out
where to keep them. In addition, we'll need to run some script to
generate the module every time a change is made to the source. This
will slow down the development cycle further.

Kristian

> --
> Anders
>
>
> ---------- Forwarded message ----------
> From: noreply@xxxxxxxxxxxxx
> To: Anders Logg <logg@xxxxxxxxx>
> Date: Tue, 31 Aug 2010 09:49:22 -0000
> Subject: [Branch ~dolfin-core/dolfin/main] Rev 5120: Add docstrings for all Python classes/functions generated by Swig.
> ------------------------------------------------------------
> revno: 5120
> committer: Kristian B. Ølgaard <k.b.oelgaard@xxxxxxxxx>
> branch nick: dolfin
> timestamp: Tue 2010-08-31 11:43:50 +0200
> message:
>  Add docstrings for all Python classes/functions generated by Swig.
> modified:
>  dolfin/swig/generate.py
>  dolfin/swig/import/mesh.i
>  dolfin/swig/kernel_modules.i
>  site-packages/dolfin/docstrings/dolfin/cpp.py
> The size of the diff (8753 lines) is larger than your specified limit of 1000 lines
>
> --
> lp:dolfin
> https://code.launchpad.net/~dolfin-core/dolfin/main
>
> Your team DOLFIN Core Team is subscribed to branch lp:dolfin.
> To unsubscribe from this branch go to https://code.launchpad.net/~dolfin-core/dolfin/main/+edit-subscription
>
> _______________________________________________
> Mailing list: https://launchpad.net/~dolfin
> Post to     : dolfin@xxxxxxxxxxxxxxxxxxx
> Unsubscribe : https://launchpad.net/~dolfin
> More help   : https://help.launchpad.net/ListHelp
>
>