Sphinx/docutils is expanding tabs to 8 spaces which looks odd/ugly, to
work around this I convert tabs to 4 spaces when pulling doc strings but
it does make things easier if the following could be changed on
http://wiki.dabodev.com/CodingGuidelines .
def someComplexMethod(self,val):
"""This is a very complex method. In order for you to understand
what it's doing, I need to explain a lot of the steps involved, so
that's why this docstring is so long.
"""
<lots of code follows...>
to:
def someComplexMethod(self,val):
"""
This is a very complex method. In order for you to understand
what it's doing, I need to explain a lot of the steps involved, so
that's why this docstring is so long.
"""
<lots of code follows...>
or even nicer (in the final doc):
def someComplexMethod(self,val, val2):
"""
This is a very complex method. In order for you to understand
what it's doing, I need to explain a lot of the steps involved, so
that's why this docstring is so long.
:param val: an explanation for val
:param val2: what is val2
:rtype: a list of strings or whatever
If one includes some code, prefix it with two columns and a blank line and
indent it::
x = someComplexMethod(x1, x2)
Followed by a blank line and optionally some more stuff.
"""
<lots of code follows...>
Hope this is fine with everyone.
End result sample can be seen here:
http://thewinecellarbook.com/daboDocTest/dabo.biz.RemoteBizobj.RemoteBizobj.html#dabo.biz.RemoteBizobj.addJoin
Werner
P.S.
I will make most if not all of these in the existing code when I go
through it for other things which need changing to get rid of Sphinx
warnings.
_______________________________________________
Post Messages to: [email protected]
Subscription Maintenance: http://leafe.com/mailman/listinfo/dabo-users
Searchable Archives: http://leafe.com/archives/search/dabo-users
This message: http://leafe.com/archives/byMID/[email protected]
