Misc doc changes for tarfile

[merwok]

BPO	14056
Nosy	@gustaebel, @merwok, @bitdancer
Files	misc-tarfile-doc-changes-3.2.diff lars-comment.diff misc-tarfile-doc-changes-3.2.diff

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = 'https://github.com/merwok'
closed_at = <Date 2014-10-04.00:31:28.010>
created_at = <Date 2012-02-19.23:32:55.027>
labels = ['docs']
title = 'Misc doc changes for tarfile'
updated_at = <Date 2014-10-04.00:31:28.007>
user = 'https://github.com/merwok'

bugs.python.org fields:

activity = <Date 2014-10-04.00:31:28.007>
actor = 'r.david.murray'
assignee = 'eric.araujo'
closed = True
closed_date = <Date 2014-10-04.00:31:28.010>
closer = 'r.david.murray'
components = ['Documentation']
creation = <Date 2012-02-19.23:32:55.027>
creator = 'eric.araujo'
dependencies = []
files = ['24571', '24598', '24609']
hgrepos = []
issue_num = 14056
keywords = ['patch']
message_count = 6.0
messages = ['153733', '153942', '154025', '228413', '228419', '228420']
nosy_count = 4.0
nosy_names = ['lars.gustaebel', 'eric.araujo', 'r.david.murray', 'python-dev']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue14056'
versions = ['Python 3.5']

[merwok]

A few things to improve in tarfile’s doc:

a) I found the heading “The following variables are available on module level” strange; does “variable” mean that users are able to edit tarfile.ENCODING to control the default encoding used? The answer is no, as ENCODING is bound to a function default argument value and a class attribute at import time. I suggest changing this heading for something like “Module-level constants”, and move it before the doc for the *_FORMATS constants (the attached diff makes it look like I moved these constants, but I actually moved ENCODING—same result).

b) The doc does not say that the availability of compression formats depends on the optional compilation of some modules. Someone following the link to the module docs for gzip, bz2 or lzma can find the info, but I think a bit more explicitness wouldn’t hurt. The attached patch for 3.2 tries to inline the info, but is a bit clumsy; alternatively, a table like this could be added near the top:

Support depends on the availability of certain optional modules:

========= =========================================== =============
Format Description Requires
========= =========================================== =============
``xz`` xz'ed tar file (:file:`.tar.xz`) :mod:`lzma`
``bz2`` bzip2'ed tar file (:file:`.tar.bz2`) :mod:`bz2`
``gz`` gzip'ed tar file (:file:`.tar.gz`) :mod:`gzip`
========= =========================================== =============

c) The seealso section links to zipfile, just like the into text, but not to shutil.

Please let me know what suggestions you approve or reject and I’ll commit them.

[gustaebel]

a) Good point, a case of sloppy naming.

b) IMO a table is a tad too much. The amount of different compression methods is still quite small. My patch proposes a simpler approach.

c) A link to shutil is very useful.

BTW, thanks for the effort.

[merwok]

I like your idea. I’ll keep the table for shutil, which has more things to say (description, file extensions, etc.).

[python-dev]

New changeset a486b673b57f by R David Murray in branch '3.4':
bpo-14056: Small improvements to the tarfile documentation.
https://hg.python.org/cpython/rev/a486b673b57f

New changeset ab828eeee2b2 by R David Murray in branch 'default':
Merge: bpo-14056: Small improvements to the tarfile documentation.
https://hg.python.org/cpython/rev/ab828eeee2b2

[python-dev]

New changeset 378f3d237ac2 by R David Murray in branch '2.7':
bpo-14056: Small improvements to the tarfile documentation.
https://hg.python.org/cpython/rev/378f3d237ac2

[bitdancer]

Committed Éric's patch.