Luis Zarrabeitia wrote:
What's the preferred style to document code in python? ...
def somefunction(arg1, arg2, out = sys.stdout):
""" This function does blahblablha with the string arg1, using
the tuple of ints arg2 as the control sequence, and prints the
result to out (defaults to
Quoting Chris Rebert :
>
> It's pretty subjective based on which documentation generator you use
> (or if you don't use one at all, just your personal style), but
> personally I'd recommend reStructuredText and Sphinx
> (http://sphinx.pocoo.org/) since they're used for the std lib's very
> spiff
On Thu, Mar 19, 2009 at 6:26 AM, Luis Zarrabeitia wrote:
>
> What's the preferred style to document code in python? I usually do something
> like this:
>
> ===
> def somefunction(arg1, arg2, out = sys.stdout):
> """ This function does blahblablha with the string arg1, using
> the tuple of in
What's the preferred style to document code in python? I usually do something
like this:
===
def somefunction(arg1, arg2, out = sys.stdout):
""" This function does blahblablha with the string arg1, using
the tuple of ints arg2 as the control sequence, and prints the
result to out (d
