dolfin team mailing list archive

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

On 26 August 2010 18:04, Anders Logg <logg@xxxxxxxxx> wrote:
> What is the role of the docstrings module?

This is the module that contains all the docstrings for the dolfin module.
We use it to dynamically asssign to __doc__ and in the hand written
Python layer, we will use it as:

class Foo(object):
    __doc__ = docstrings.Foo.__doc__

>
> It seems strange that DOLFIN should install a module named
> 'docstrings' in the global Python namespace.

I'll delete the docstrings module in the dolfin.__init__ file such
that it is not present when doing:

>>> import dolfin
>>> dir(dolfin)

Kristian

> --
> Anders
>
>
> ---------- Forwarded message ----------
> From: noreply@xxxxxxxxxxxxx
> To: Anders Logg <logg@xxxxxxxxx>
> Date: Thu, 26 Aug 2010 15:58:22 -0000
> Subject: [Branch ~dolfin-core/dolfin/main] Rev 5081: Integrate FEniCS documentation with DOLFIN to get correct docstrings for the Python module.
> ------------------------------------------------------------
> revno: 5081
> committer: Kristian B. Ølgaard <k.b.oelgaard@xxxxxxxxx>
> branch nick: dolfin
> timestamp: Thu 2010-08-26 17:11:03 +0200
> message:
>  Integrate FEniCS documentation with DOLFIN to get correct docstrings for the Python module.
> added:
>  dolfin/swig/documentation.py
>  site-packages/docstrings/
>  site-packages/docstrings/dolfin/
>  site-packages/docstrings/dolfin/__init__.py
>  site-packages/docstrings/dolfin/cpp.py
> modified:
>  CMakeLists.txt
>  dolfin/swig/docstrings.i
>  dolfin/swig/generate.py
>  site-packages/dolfin/__init__.py
> The size of the diff (8610 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
>
>