Oops, you're right.
What I should have said is to use an empty docstring
as
follows:
""""""
"""Function docstring."""
def foo:
...
or:
"""Module docstring."""
""""""
def foo:
...
So the first docstring is the module docstring, and
the next is the first class/function. And again, if
there's only one, it will belong to both.
--- Anthony Baxter <[EMAIL PROTECTED]> wrote:
> On Monday 21 March 2005 20:08, Nicholas Jacobson
> wrote:
> > > How do you distinguish between a docstring at
> the
> > > top of a module
> > > that's immediately followed by a function? Is
> it
> > > the module docstring
> > > or the function docstring?
> >
> > It's both. The docstring would be assigned to
> both
> > the module and the function. This is a *good*
> thing
> > when there is a module with only one function in
> it.
> > i.e. there should only be one docstring for both,
> and
> > this saves repetition of that docstring.
> >
> > If a programmer wanted a docstring for the
> function
> > but not the module, a blank first line would do
> the
> > trick. A docstring for the module but not the
> > function? Put a blank line between the module's
> > docstring and the function.
>
> Yuk. This is magic taken to a ridiculous level. Note
> that
> "blank lines" currently have no meaning in Python,
> and adding
> a meaning to them is not my idea of a good thing.
>
> --
> Anthony Baxter <[EMAIL PROTECTED]>
> It's never too late to have a happy childhood.
>
__________________________________
Do you Yahoo!?
Yahoo! Small Business - Try our new resources site!
http://smallbusiness.yahoo.com/resources/
_______________________________________________
Python-Dev mailing list
Python-Dev@python.org
http://mail.python.org/mailman/listinfo/python-dev
Unsubscribe:
http://mail.python.org/mailman/options/python-dev/archive%40mail-archive.com
