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 tarfile documentation bug
Type: enhancement Stage: resolved
Components: Documentation Versions: Python 3.4, Python 3.5, Python 2.7
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: rhettinger Nosy List: berker.peksag, docs@python, eric.araujo, lurchman, maatt, python-dev, rhettinger, serhiy.storchaka
Priority: normal Keywords: patch

Created on 2014-04-10 16:43 by lurchman, last changed 2022-04-11 14:58 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
issue21198.diff berker.peksag, 2014-05-12 14:51 review
Messages (8)
msg215892 - (view) Author: Andrew Scheller (lurchman) * Date: 2014-04-10 16:43
I've just noticed that the documentation for TarInfo.type says
"To determine the type of a TarInfo object more conveniently, use the is_*() methods below."

However none of the methods mentioned actually contain an underscore, so I believe the documentation should be updated to "...use the is*() methods below."

(for comparison, the documentation for stat.S_IFMT correctly talks about "is*() functions")
msg215962 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2014-04-12 06:28
Thanks for the report.  Is it an issue in the docstrings, the HTML documentation or both?
msg216109 - (view) Author: Matt Chaput (maatt) Date: 2014-04-14 16:53
Simple patch to remove the underscore in tarfile.rst.
msg216147 - (view) Author: Andrew Scheller (lurchman) * Date: 2014-04-14 18:12
Éric - appears to be only Doc/library/tarfile.rst that is affected.

Matt - looks like your "simple patch" contains a lot more than you intended?!
msg216236 - (view) Author: Matt Chaput (maatt) Date: 2014-04-14 22:23
Oops! Yes, I accidentally included a bunch of other crap.
msg218931 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2014-05-22 23:04
New changeset 630bc60cba04 by Raymond Hettinger in branch '3.4':
Issue 21198: Minor tarfile documentation bug.
http://hg.python.org/cpython/rev/630bc60cba04
msg218932 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2014-05-22 23:06
New changeset 5c1fb67f2edf by Raymond Hettinger in branch '2.7':
Issue 21198: Minor tarfile documentation bug.
http://hg.python.org/cpython/rev/5c1fb67f2edf
msg218933 - (view) Author: Raymond Hettinger (rhettinger) * (Python committer) Date: 2014-05-22 23:06
Thanks for the report and the patch.
Fixed now :-)
History
Date User Action Args
2022-04-11 14:58:01adminsetgithub: 65397
2014-05-23 01:25:22berker.peksagsetstage: patch review -> resolved
2014-05-22 23:06:48rhettingersetstatus: open -> closed
resolution: fixed
messages: + msg218933
2014-05-22 23:06:11python-devsetmessages: + msg218932
2014-05-22 23:04:40python-devsetnosy: + python-dev
messages: + msg218931
2014-05-22 23:00:51rhettingersetassignee: docs@python -> rhettinger

nosy: + rhettinger
2014-05-12 14:51:22berker.peksagsetfiles: + issue21198.diff
nosy: + berker.peksag, serhiy.storchaka

stage: needs patch -> patch review
2014-05-11 00:06:28ezio.melottisettype: enhancement
stage: needs patch
2014-04-14 22:23:56maattsetmessages: + msg216236
2014-04-14 22:23:12maattsetfiles: - issue21198.patch
2014-04-14 18:12:57lurchmansetmessages: + msg216147
2014-04-14 16:53:09maattsetfiles: + issue21198.patch

nosy: + maatt
messages: + msg216109

keywords: + patch
2014-04-12 06:28:32eric.araujosetnosy: + eric.araujo
messages: + msg215962
2014-04-10 17:01:25berker.peksagsettype: enhancement -> (no value)
versions: - Python 3.1, Python 3.2, Python 3.3
2014-04-10 16:43:47lurchmancreate