mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-22 17:16:24 +00:00
Code Issues 25 Releases Wiki Activity

Changed docstrings in admindocs/utils to comply to PEP 257

Browse Source
This commit is contained in:
Zan Anderle 2014-11-03 19:24:22 +01:00 committed by Tim Graham
parent 2d06e3155a
commit 1cf109515a
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
django/contrib/admindocs/utils.py
View File

@ -19,9 +19,9 @@ else:
def trim_docstring(docstring):
"""
Uniformly trims leading/trailing whitespace from docstrings.
Uniformly trim leading/trailing whitespace from docstrings.
Based on http://www.python.org/peps/pep-0257.html#handling-docstring-indentation
Based on https://www.python.org/dev/peps/pep-0257/#handling-docstring-indentation
"""
if not docstring or not docstring.strip():
return ''
@ -34,7 +34,7 @@ def trim_docstring(docstring):
def parse_docstring(docstring):
"""
Parse out the parts of a docstring. Returns (title, body, metadata).
Parse out the parts of a docstring. Return (title, body, metadata).
"""
docstring = trim_docstring(docstring)
parts = re.split(r'\n{2,}', docstring)