[issue28513] Documment zipfile CLI
New submission from Serhiy Storchaka: Command-line interface of the zipfile module is supported long time, but it is not documented. Proposed patch documents it. It is based on the documentation of tarfile CLI. ---------- assignee: docs@python components: Documentation files: zipfile_cli_docs.patch keywords: patch messages: 279250 nosy: alanmcintyre, berker.peksag, docs@python, serhiy.storchaka, twouters priority: normal severity: normal stage: patch review status: open title: Documment zipfile CLI type: enhancement versions: Python 2.7, Python 3.5, Python 3.6, Python 3.7 Added file: http://bugs.python.org/file45195/zipfile_cli_docs.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue28513> _______________________________________
Changes by Serhiy Storchaka <storchaka+cpython@gmail.com>: ---------- title: Documment zipfile CLI -> Document zipfile CLI _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue28513> _______________________________________
Stéphane Wirtel added the comment: Serhiy, your patch seems to be good, you can merge it, I have tested it with sphinx and the documentation is fine. Thanks ---------- nosy: +matrixise _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue28513> _______________________________________
Changes by Stéphane Wirtel <stephane@wirtel.be>: ---------- stage: patch review -> commit review _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue28513> _______________________________________
Changes by Serhiy Storchaka <storchaka+cpython@gmail.com>: ---------- nosy: +martin.panter _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue28513> _______________________________________
Xiang Zhang added the comment: LGTM. ---------- nosy: +xiang.zhang _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue28513> _______________________________________
SilentGhost added the comment: Serhiy, this needs .. program:: zipfile directive specified before cmdoption. Without it :option:`-c` links to python's -c, rather than zipfile's. The -l and -e are linked correctly, but the option links would have be be changed for all three, i.e. to :option:`-c <zipfile -c>` ---------- nosy: +SilentGhost stage: commit review -> patch review _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue28513> _______________________________________
Serhiy Storchaka added the comment: Thanks SilentGhost! ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue28513> _______________________________________
Martin Panter added the comment: Apparently (haven’t tried myself) if you put “.. program:: zipfile” before the :option: invocations, it changes the default context and you don’t need the <zipfile . . .> bit. The text in general looks fine. One very minor thing: I would use a hyphen when “command line” is a modifier on another noun, i.e. command-line interface, command-line options. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue28513> _______________________________________
SilentGhost added the comment:
Apparently (haven’t tried myself) if you put “.. program:: zipfile” before the :option: invocations, it changes the default context and you don’t need the <zipfile . . .> bit.
Yes, moving program directive just after "Command Line Interface" heading works fine. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue28513> _______________________________________
Changes by armando mendoza <amendoza0101@gmail.com>: ---------- components: +XML _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue28513> _______________________________________
Changes by SilentGhost <ghost.adh@runbox.com>: ---------- components: -XML _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue28513> _______________________________________
Changes by Serhiy Storchaka <storchaka+cpython@gmail.com>: ---------- assignee: docs@python -> serhiy.storchaka _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue28513> _______________________________________
Roundup Robot added the comment: New changeset feb6e8678512 by Serhiy Storchaka in branch '2.7': Issue #28513: Documented command-line interface of zipfile. https://hg.python.org/cpython/rev/feb6e8678512 New changeset b51bf32defb1 by Serhiy Storchaka in branch '3.5': Issue #28513: Documented command-line interface of zipfile. https://hg.python.org/cpython/rev/b51bf32defb1 New changeset 843538a4094b by Serhiy Storchaka in branch '3.6': Issue #28513: Documented command-line interface of zipfile. https://hg.python.org/cpython/rev/843538a4094b New changeset 0c8ffa562f3a by Serhiy Storchaka in branch 'default': Issue #28513: Documented command-line interface of zipfile. https://hg.python.org/cpython/rev/0c8ffa562f3a ---------- nosy: +python-dev _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue28513> _______________________________________
Serhiy Storchaka added the comment: Applied both Martin's suggestion. Thank you all! ---------- resolution: -> fixed stage: patch review -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue28513> _______________________________________
Changes by Donald Stufft <donald@stufft.io>: ---------- pull_requests: +954 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue28513> _______________________________________
participants (8)
-
armando mendoza -
Donald Stufft
-
Martin Panter
-
Roundup Robot
-
Serhiy Storchaka
-
SilentGhost
-
Stéphane Wirtel
-
Xiang Zhang