This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Four quotes used to begin docstring
Type: enhancement Stage: resolved
Components: Documentation, Library (Lib) Versions: Python 3.6, Python 3.4, Python 3.5
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: abarry, docs@python, jayvdb, python-dev, zach.ware
Priority: normal Keywords: patch

Created on 2015-10-27 21:48 by jayvdb, last changed 2022-04-11 14:58 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
cpython-statistics.patch jayvdb, 2015-10-27 21:48 Fix review
Messages (7)
msg253568 - (view) Author: John Mark Vandenberg (jayvdb) * Date: 2015-10-27 21:48
Introduced in the initial version of statistics was """" starting a docstring

https://hg.python.org/cpython/annotate/685e044bed5e/Lib/statistics.py#l380

Somewhere the fourth quote is dropped, as it doesnt appear in the docs:

https://docs.python.org/3/library/statistics.html#statistics.median_grouped
msg253569 - (view) Author: John Mark Vandenberg (jayvdb) * Date: 2015-10-27 22:02
The additional quotation mark is shown in help()

>>> help(statistics.median_grouped)
Help on function median_grouped in module statistics:

median_grouped(data, interval=1)
    "Return the 50th percentile (median) of grouped continuous data.
msg253579 - (view) Author: Anilyka Barry (abarry) * (Python triager) Date: 2015-10-28 01:21
I don't know why you believe docstrings are programmatically linked to the library reference...

Here is the file that is used to make the online documentation: https://hg.python.org/cpython/file/tip/Doc/library/statistics.rst
msg253580 - (view) Author: John Mark Vandenberg (jayvdb) * Date: 2015-10-28 01:35
Thank you for clarifying that.
Does that mean that this issue should not be assigned to docs@python and should not have a Component of 'Documentation'?
msg253581 - (view) Author: Anilyka Barry (abarry) * (Python triager) Date: 2015-10-28 02:14
It probably shouldn't be assigned to docs@python, but it's still a typo in the source code, so it should probably be under Library anyway.

LGTM
msg253582 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2015-10-28 03:06
New changeset 041701817c5d by Zachary Ware in branch '3.4':
Issue #25494: Remove extra quote from docstring.
https://hg.python.org/cpython/rev/041701817c5d

New changeset 2dd97ad96021 by Zachary Ware in branch '3.5':
Issue #25494: Merge with 3.4
https://hg.python.org/cpython/rev/2dd97ad96021

New changeset d9bb7a3ed51e by Zachary Ware in branch 'default':
Closes #25494: Merge with 3.5
https://hg.python.org/cpython/rev/d9bb7a3ed51e
msg253583 - (view) Author: Zachary Ware (zach.ware) * (Python committer) Date: 2015-10-28 03:07
Documentation is fine for docstrings, it gets the attention of the docs@ list.  Library is also fine, since the change actually goes in Lib/.  Both is most correct :)

Thanks for the report and patch!
History
Date User Action Args
2022-04-11 14:58:23adminsetgithub: 69680
2015-10-28 03:07:32zach.waresetnosy: + zach.ware
messages: + msg253583
2015-10-28 03:06:07python-devsetstatus: open -> closed

nosy: + python-dev
messages: + msg253582

resolution: fixed
stage: resolved
2015-10-28 02:14:58abarrysetmessages: + msg253581
2015-10-28 01:35:27jayvdbsetmessages: + msg253580
2015-10-28 01:21:05abarrysetnosy: + abarry
messages: + msg253579
2015-10-27 22:02:23jayvdbsetmessages: + msg253569
2015-10-27 21:48:58jayvdbcreate