mirror of
https://github.com/davidhalter/jedi.git
synced 2025-12-08 14:54:47 +08:00
docstrings: fix "Sphinx param with type" pattern (#807)
* docstrings: fix "Sphinx param with type" pattern
Previously, the pattern only matched if the parameter description
followed on the same line, like so:
:param type foo: A param named foo.
However, it's also valid for the parameter description to be wrapped
onto the next line, like so:
:param type foo:
A param named foo.
This change updates the pattern to match the second example as well, and
adds a test to verify this behaviour.
Fixes #806.
* Add Simon Ruggier to the AUTHORS file
This commit is contained in:
committed by
Dave Halter
parent
e8718c6ce5
commit
338ea42ed9
@@ -49,6 +49,17 @@ def sphinxy2(a, b, x):
|
||||
#?
|
||||
sphinxy2()
|
||||
|
||||
|
||||
def sphinxy_param_type_wrapped(a):
|
||||
"""
|
||||
:param str a:
|
||||
Some description wrapped onto the next line with no space after the
|
||||
colon.
|
||||
"""
|
||||
#? str()
|
||||
a
|
||||
|
||||
|
||||
# local classes -> github #370
|
||||
class ProgramNode():
|
||||
pass
|
||||
|
||||
Reference in New Issue
Block a user