Python snippets docstrings adhere to PEP 257.

These changes bring the presentation of Python docstrings within the
Python snippets inline with the standards set out in PEP 257.
http://www.python.org/dev/peps/pep-0257/

The changes include: making sure that there is a blank line between the
end of a multiline docstring and the closing triple-quotes; making sure
code starts on the next immediate line after a docstring (no blank lines
following a docstring); removing trailing whitespace from docstring
lines.
This commit is contained in:
Chris Lasher 2012-03-01 17:14:08 -05:00
parent f8af2e2fa6
commit 2ee0b01e60

View File

@ -61,7 +61,7 @@ def write_docstring_args(args, snip):
snip.rv += ' """'
return
snip += ""
snip.rv += '\n' + snip.mkline('', indent='')
style = get_style(snip)
@ -77,7 +77,7 @@ def write_init_body(args, parents, snip):
snip += p + ".__init__(self)"
if parents:
snip += ""
snip.rv += '\n' + snip.mkline('', indent='')
for arg in args:
snip += "self._%s = %s" % (arg, arg)
@ -105,10 +105,10 @@ snip >> 2
args = get_args(t[4])
write_docstring_args(args, snip)
if args: snip += '"""'
if args:
snip.rv += '\n' + snip.mkline('', indent='')
snip += '"""'
snip += ""
write_init_body(args, t[2], snip)
`
$0
@ -118,7 +118,7 @@ endsnippet
snippet slotclass "class with slots and docstrings" b
class ${1:MyClass}(${2:object}):
"""${3:Docstring for $1 }"""
`!p
`!p
snip >> 1
args = get_args(t[4])
write_slots_args(args, snip)
@ -132,9 +132,10 @@ snip >> 2
args = get_args(t[4])
write_docstring_args(args, snip)
if args: snip += '"""'
if args:
snip.rv += '\n' + snip.mkline('', indent='')
snip += '"""'
snip += ""
write_init_body(args, t[2], snip)
`
$0
@ -336,8 +337,8 @@ if args:
style = get_style(snip)
snip += format_return(style)
snip.rv += '\n' + snip.mkline('', indent='')
snip += '"""' `
${0:pass}
endsnippet