You can demonstrate this by running pydoc on the module; if your docstring isn't the first thing, pydoc won't see it either (nor will a "print __doc__" in the file.) pylint will also report
foo.py:1: [C] Missing docstring foo.py:3: [W] String statement has no effect for a misplaced docstring (it's not clever enough to notice that the two are related, though.) On Sun, Apr 14, 2013 at 11:39 AM, Zbigniew Jędrzejewski-Szmek < [email protected]> wrote: > On Sun, Apr 14, 2013 at 08:28:47AM +1200, Thomi Richards wrote: > > On 13 April 2013 17:35, Takayuki Shimizukawa <[email protected]> > wrote: > > > I got the result that you expected with bot Sphinx-1.1.3 and 1.2b1. > > > Did you solve your problem yet? > > > > I figured out that my problem was because I didn't realise that > > module-level docstrings need to appear *before* any import statements. > > Is this a bug in sphinx, or is this a python requirement that I never > > realised before? > A python requirement. > > Zbyszek > > -- > You received this message because you are subscribed to the Google Groups > "sphinx-users" group. > To unsubscribe from this group and stop receiving emails from it, send an > email to [email protected]. > To post to this group, send email to [email protected]. > Visit this group at http://groups.google.com/group/sphinx-users?hl=en. > For more options, visit https://groups.google.com/groups/opt_out. > > > -- _Mark_ <[email protected]> <[email protected]> -- You received this message because you are subscribed to the Google Groups "sphinx-users" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To post to this group, send email to [email protected]. Visit this group at http://groups.google.com/group/sphinx-users?hl=en. For more options, visit https://groups.google.com/groups/opt_out.
