Christopher Lenz wrote: > I suggest we adopt reStructuredText. If there's anything that comes > somewhat close to a standard for Python docstrings, that's arguably > the one. >
Go for it. There's one additional precision I'd like to get about PEP 0257 and its guidelines for multiline docstring. Though it's very good to try to keep the summary line very concise, I've hit some rare occasions where it's not convenient to squish the right sentence in less than 80 characters... Would a docstring like the following be acceptable? """Take that as a long summary line which will not fit in 80 characters ... the rest of the docstring """ How's epydoc behaving here? Btw, speaking about line length, PEP 0008 says: Limit all lines to a maximum of 79 characters. Not a maximum of 80, like we currently say in the TracDev/CodingStyle page. And indeed my Emacs editor will be happier if we enforced that 79 characters limit ;-) -- Christian --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "Trac Development" group. To post to this group, send email to [email protected] To unsubscribe from this group, send email to [EMAIL PROTECTED] For more options, visit this group at http://groups.google.com/group/trac-dev?hl=en -~----------~----~----~----~------~----~------~--~---
