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: Minor typo in Path.samefile docstring
Type: Stage: resolved
Components: Library (Lib) Versions: Python 3.6, Python 3.5
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: Nosy List: Antony.Lee, berker.peksag, python-dev
Priority: normal Keywords:

Created on 2015-10-16 00:17 by Antony.Lee, last changed 2022-04-11 14:58 by admin. This issue is now closed.

Messages (5)
msg253066 - (view) Author: Antony Lee (Antony.Lee) * Date: 2015-10-16 00:17
The output of pydoc for Path.samefile currently reads

pathlib.Path.samefile = samefile(self, other_path)
    Return whether `other_file` is the same or not as this file.
    (as returned by os.path.samefile(file, other_file)).

It should arguably be something like

pathlib.Path.samefile = samefile(self, other_path)
    Return whether `other_path` is the same or not as this file.
    (as returned by os.path.samefile(file, other_file)).

or

pathlib.Path.samefile = samefile(self, other_path)
    Return whether `other_path` is the same or not as this file.
    (as returned by os.path.samefile(str(self), str(other_path))).
msg253298 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2015-10-21 17:10
New changeset 7d65be20e0d8 by Berker Peksag in branch '3.5':
Issue #25417: Fix typo in Path.samefile() docstring
https://hg.python.org/cpython/rev/7d65be20e0d8

New changeset 0b09a866da77 by Berker Peksag in branch 'default':
Issue #25417: Fix typo in Path.samefile() docstring
https://hg.python.org/cpython/rev/0b09a866da77
msg253299 - (view) Author: Berker Peksag (berker.peksag) * (Python committer) Date: 2015-10-21 17:11
Fixed, thank you Antony.
msg253300 - (view) Author: Antony Lee (Antony.Lee) * Date: 2015-10-21 17:20
Actually there's also an extra dot at the end of the first line of the docstring (redundant with the one on the second line).
msg253314 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2015-10-22 00:34
New changeset 642a7be9f384 by Berker Peksag in branch '3.5':
Issue #25417: Remove the extra dot from docstring
https://hg.python.org/cpython/rev/642a7be9f384

New changeset 4cd2ae001d30 by Berker Peksag in branch 'default':
Issue #25417: Remove the extra dot from docstring
https://hg.python.org/cpython/rev/4cd2ae001d30
History
Date User Action Args
2022-04-11 14:58:22adminsetgithub: 69603
2015-10-22 00:34:19python-devsetmessages: + msg253314
2015-10-21 17:20:04Antony.Leesetmessages: + msg253300
2015-10-21 17:11:24berker.peksagsetstatus: open -> closed

nosy: + berker.peksag
messages: + msg253299

resolution: fixed
stage: resolved
2015-10-21 17:10:35python-devsetnosy: + python-dev
messages: + msg253298
2015-10-16 00:21:38ethan.furmansetnosy: - ethan.furman
2015-10-16 00:21:04ethan.furmansetnosy: + ethan.furman
2015-10-16 00:17:06Antony.Leecreate