[PYTHON DOC-SIG] gendoc, etc.

[Robin Friedrich]

|> From: "Mark Hammond" <MHammond@skippinet.com.au>
|> Date:          Fri, 24 Jan 1997 15:28:26 +1000
|>  
|> > Thanks.  This is shaping up.
|> 
|> Yeah - FWIW, it looks _very_ good.  Im very impressed with the 
|> possibilities.
|> 
|> I may even write a parser that can take my already marked-up C++
|> sources, and generate docs from there too (I have a tool which makes
|> RTF).  Then an RTF formatter, and we will have winhelp files :-)
|> 
|> But Im getting ahead of my self.
|> 
|> One small problem Im having - Functions _sometimes_ dont get 
|> docstrings.
|> 
|> Eg:
|> def foo(): # No underscores - saw that bit :-)
|>   "This is foo"
|>   the_code...

yes, the bug you're running into is that for some reason a doc string
in a top level function must have a newline in it to be detected as 
having a doc string. Note that this doesn't seem to affect methods
or classes. 
The following would work however...

   def foo(): 
	 """This is foo.
	 """
	 the_code...

|> 
|> I get foo listed as a function in the module, but no docstring for 
|> it....
|> 
|> Thanks,
|> 
|> Mark.

_______________
DOC-SIG  - SIG for the Python Documentation Project

send messages to: doc-sig@python.org
administrivia to: doc-sig-request@python.org
_______________