Menu

#212 Support for alternate docstrings.

open
nobody
None
5
2007-03-07
2007-03-07
No

It would be cool if we could somehow leverage PyDev's brains to tweak the syntax of the docstrings.

For instance, if a user has settled on using reStructuredText (or whatever the flavor of the day is) for their docstrings, it would be nice if they can get a customized Docstring completion depending on what their preference is.

For instance, say I have :

def method(one,two):

Instead of the auto-magic docstring creation doing this:

"""

@param one:
@param two:
"""

It would be nice if it could do this:

"""

:Parameters:
`one`:
`two`:
"""

What would be awesome would be to have customizable docstring templates with some {params} placeholder in PyDev's prefs for different docformats. Then have PyDev sniff any defined __docformat__ setting for the current document and pick the correct docstring templates, else use "the default one" :-)

Discussion

Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.