➜
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.
Created on 2016-10-23 10:36 by serhiy.storchaka, last changed 2022-04-11 14:58 by admin. This issue is now closed.
| Files | ||||
|---|---|---|---|---|
| File name | Uploaded | Description | Edit | |
| zipfile_cli_docs.patch | serhiy.storchaka, 2016-10-23 10:36 | |||
| Pull Requests | |||
|---|---|---|---|
| URL | Status | Linked | Edit |
| PR 552 | closed | dstufft, 2017-03-31 16:36 | |
| Messages (9) | |||
|---|---|---|---|
| msg279250 - (view) | Author: Serhiy Storchaka (serhiy.storchaka) *  |
Date: 2016-10-23 10:36 | |
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. |
|||
| msg279256 - (view) | Author: Stéphane Wirtel (matrixise) * |
Date: 2016-10-23 12:24 | |
Serhiy, your patch seems to be good, you can merge it, I have tested it with sphinx and the documentation is fine. Thanks |
|||
| msg279760 - (view) | Author: Xiang Zhang (xiang.zhang) * |
Date: 2016-10-31 02:58 | |
LGTM. |
|||
| msg279807 - (view) | Author: SilentGhost (SilentGhost) *  |
Date: 2016-10-31 17:04 | |
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>` |
|||
| msg279819 - (view) | Author: Serhiy Storchaka (serhiy.storchaka) * |
Date: 2016-10-31 18:34 | |
Thanks SilentGhost! |
|||
| msg279835 - (view) | Author: Martin Panter (martin.panter) * |
Date: 2016-10-31 21:59 | |
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. |
|||
| msg279857 - (view) | Author: SilentGhost (SilentGhost) * |
Date: 2016-11-01 07:10 | |
> 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. |
|||
| msg279917 - (view) | Author: Roundup Robot (python-dev) |
Date: 2016-11-02 10:14 | |
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 |
|||
| msg279918 - (view) | Author: Serhiy Storchaka (serhiy.storchaka) * |
Date: 2016-11-02 10:16 | |
Applied both Martin's suggestion. Thank you all! |
|||
| History | |||
|---|---|---|---|
| Date | User | Action | Args |
| 2022-04-11 14:58:38 | admin | set | github: 72699 |
| 2017-03-31 16:36:21 | dstufft | set | pull_requests: + pull_request954 |
| 2016-11-02 10:16:03 | serhiy.storchaka | set | status: open -> closed resolution: fixed messages: + msg279918 stage: patch review -> resolved |
| 2016-11-02 10:14:10 | python-dev | set | nosy:
+ python-dev messages: + msg279917 |
| 2016-11-02 09:47:19 | serhiy.storchaka | set | assignee: docs@python -> serhiy.storchaka |
| 2016-11-01 11:28:39 | SilentGhost | set | components: - XML |
| 2016-11-01 10:55:12 | armando mendoza | set | components: + XML |
| 2016-11-01 07:10:10 | SilentGhost | set | messages: + msg279857 |
| 2016-10-31 21:59:40 | martin.panter | set | messages: + msg279835 |
| 2016-10-31 18:34:38 | serhiy.storchaka | set | messages: + msg279819 |
| 2016-10-31 17:04:35 | SilentGhost | set | nosy:
+ SilentGhost messages: + msg279807 stage: commit review -> patch review |
| 2016-10-31 02:58:06 | xiang.zhang | set | nosy:
+ xiang.zhang messages: + msg279760 |
| 2016-10-30 17:01:02 | serhiy.storchaka | set | nosy:
+ martin.panter |
| 2016-10-23 12:24:21 | matrixise | set | stage: patch review -> commit review |
| 2016-10-23 12:24:16 | matrixise | set | nosy:
+ matrixise messages: + msg279256 |
| 2016-10-23 11:05:52 | serhiy.storchaka | set | title: Documment zipfile CLI -> Document zipfile CLI |
| 2016-10-23 10:36:17 | serhiy.storchaka | create | |