Issue 28678: tarfile extract docs inconsistent naming of parameter numeric_owner or numeric_only (original) (raw)

This issue has been migrated to GitHub: https://github.com/python/cpython/issues/72864

classification

Title: tarfile extract docs inconsistent naming of parameter numeric_owner or numeric_only
Type: behavior Stage: resolved
Components: Documentation Versions: Python 3.7, Python 3.6, Python 3.5

process

Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, martin.panter, pseudonym, python-dev
Priority: normal Keywords: easy

Created on 2016-11-12 21:43 by pseudonym, last changed 2022-04-11 14:58 by admin. This issue is now closed.

Messages (4)
msg280673 - (view) Author: Lewis McCarthy (pseudonym) Date: 2016-11-12 21:43
https://docs.python.org/3/library/tarfile.html#tarfile-objects Most of the documentation for the extract and extractall methods refers to a parameter named numeric_owner. However, the notes on what changed in v3.5 refer instead to numeric_only. One of these names is incorrect and should be changed to match the other. Same issue in the 3.6 and 3.7 docs. https://docs.python.org/3.6/library/tarfile.html#tarfile-objects https://docs.python.org/3.7/library/tarfile.html#tarfile-objects
msg280719 - (view) Author: Martin Panter (martin.panter) * (Python committer) Date: 2016-11-13 22:05
The offending commit is revision 6b70f16d585a. The true name is numeric_owner; numeric_only is wrong. The name also needs fixing in Doc/whatsnew/3.5.rst.
msg280722 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2016-11-13 23:53
New changeset 4aca14dbb66d by Martin Panter in branch '3.5': Issue #28678: Fix references to numeric_owner parameter https://hg.python.org/cpython/rev/4aca14dbb66d New changeset 5efa1a39ee59 by Martin Panter in branch '3.6': Issue #28678: Merge parameter name from 3.5 into 3.6 https://hg.python.org/cpython/rev/5efa1a39ee59 New changeset 817a003ecdc6 by Martin Panter in branch 'default': Issue #28678: Merge parameter name from 3.6 https://hg.python.org/cpython/rev/817a003ecdc6
msg280723 - (view) Author: Martin Panter (martin.panter) * (Python committer) Date: 2016-11-14 00:29
Thanks Lewis
History
Date User Action Args
2022-04-11 14:58:39 admin set github: 72864
2016-11-14 00:29:36 martin.panter set status: open -> closedresolution: fixedmessages: + stage: needs patch -> resolved
2016-11-13 23:53:23 python-dev set nosy: + python-devmessages: +
2016-11-13 22:05:39 martin.panter set nosy: + martin.pantermessages: +
2016-11-12 22:47:31 serhiy.storchaka set keywords: + easystage: needs patch
2016-11-12 21:43:17 pseudonym create