VimPlug/jedi
1
0
Fork 1
mirror of https://github.com/davidhalter/jedi.git synced 2026-05-19 23:09:43 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fix typo s/Epidoc/Epydoc/g and add links for markups

Browse Source
This commit is contained in:
Takafumi Arakaki
2013-02-15 18:31:05 +01:00
parent ea9a667425
commit 98a6febb50
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
jedi/docstrings.py
+4 -4
View File
@@ -4,8 +4,8 @@ Docstrings are another source of information for functions and classes.
parsing is much easier. There are two different types of docstrings that |jedi| parsing is much easier. There are two different types of docstrings that |jedi|
understands: understands:
- Sphinx - `Sphinx <http://sphinx-doc.org/markup/desc.html#info-field-lists>`_
- Epidoc - `Epydoc <http://epydoc.sourceforge.net/manual-fields.html>`_
For example, the sphinx annotation ``:type foo: str`` clearly states that the For example, the sphinx annotation ``:type foo: str`` clearly states that the
type of ``foo`` is ``str``. type of ``foo`` is ``str``.
@@ -23,12 +23,12 @@ import parsing
DOCSTRING_PARAM_PATTERNS = [ DOCSTRING_PARAM_PATTERNS = [
r'\s*:type\s+%s:\s*([^\n]+)', # Sphinx r'\s*:type\s+%s:\s*([^\n]+)', # Sphinx
r'\s*@type\s+%s:\s*([^\n]+)', # Epidoc r'\s*@type\s+%s:\s*([^\n]+)', # Epydoc
] ]
DOCSTRING_RETURN_PATTERNS = [ DOCSTRING_RETURN_PATTERNS = [
re.compile(r'\s*:rtype:\s*([^\n]+)', re.M), # Sphinx re.compile(r'\s*:rtype:\s*([^\n]+)', re.M), # Sphinx
re.compile(r'\s*@rtype:\s*([^\n]+)', re.M), # Epidoc re.compile(r'\s*@rtype:\s*([^\n]+)', re.M), # Epydoc
] ]
REST_ROLE_PATTERN = re.compile(r':[^`]+:`([^`]+)`') REST_ROLE_PATTERN = re.compile(r':[^`]+:`([^`]+)`')