Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document zipfile CLI #72699

Closed
serhiy-storchaka opened this issue Oct 23, 2016 · 9 comments
Closed

Document zipfile CLI #72699

serhiy-storchaka opened this issue Oct 23, 2016 · 9 comments
Assignees
@serhiy-storchaka
Labels
3.7 (EOL) end of life docs Documentation in the Doc dir type-feature A feature request or enhancement

Comments

@serhiy-storchaka
Copy link
Member

BPO 28513
Nosy @Yhg1s, @berkerpeksag, @vadmium, @serhiy-storchaka, @matrixise, @zhangyangyu
PRs
  • [Do Not Merge] Convert Misc/NEWS so that it is managed by towncrier #552
    		•
    Files
  • zipfile_cli_docs.patch
    		•

    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/serhiy-storchaka'
closed_at = <Date 2016-11-02.10:16:03.718>
created_at = <Date 2016-10-23.10:36:17.153>
labels = ['type-feature', '3.7', 'docs']
title = 'Document zipfile CLI'
updated_at = <Date 2017-03-31.16:36:21.928>
user = 'https://github.com/serhiy-storchaka'

    bugs.python.org fields:

    activity = <Date 2017-03-31.16:36:21.928>
actor = 'dstufft'
assignee = 'serhiy.storchaka'
closed = True
closed_date = <Date 2016-11-02.10:16:03.718>
closer = 'serhiy.storchaka'
components = ['Documentation']
creation = <Date 2016-10-23.10:36:17.153>
creator = 'serhiy.storchaka'
dependencies = []
files = ['45195']
hgrepos = []
issue_num = 28513
keywords = ['patch']
message_count = 9.0
messages = ['279250', '279256', '279760', '279807', '279819', '279835', '279857', '279917', '279918']
nosy_count = 10.0
nosy_names = ['twouters', 'alanmcintyre', 'SilentGhost', 'docs@python', 'python-dev', 'berker.peksag', 'martin.panter', 'serhiy.storchaka', 'matrixise', 'xiang.zhang']
pr_nums = ['552']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue28513'
versions = ['Python 2.7', 'Python 3.5', 'Python 3.6', 'Python 3.7']
    @serhiy-storchaka
    Copy link
    Member Author

    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.

    @serhiy-storchaka serhiy-storchaka added 3.7 (EOL) end of life docs Documentation in the Doc dir type-feature A feature request or enhancement labels Oct 23, 2016
    @serhiy-storchaka serhiy-storchaka changed the title Documment zipfile CLI Document zipfile CLI Oct 23, 2016
    @matrixise
    Copy link
    Member

    Serhiy, your patch seems to be good, you can merge it, I have tested it with sphinx and the documentation is fine.

    Thanks

    @zhangyangyu
    Copy link
    Member

    LGTM.

    @SilentGhost
    Copy link
    Mannequin

    SilentGhost mannequin commented Oct 31, 2016

    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>`

    @serhiy-storchaka
    Copy link
    Member Author

    Thanks SilentGhost!

    @vadmium
    Copy link
    Member

    vadmium commented Oct 31, 2016

    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.

    @SilentGhost
    Copy link
    Mannequin

    SilentGhost mannequin commented Nov 1, 2016

    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.

    @armandomendoza armandomendoza mannequin added the topic-XML label Nov 1, 2016
    @SilentGhost SilentGhost mannequin removed the topic-XML label Nov 1, 2016
    @python-dev
    Copy link
    Mannequin

    python-dev mannequin commented Nov 2, 2016

    New changeset feb6e8678512 by Serhiy Storchaka in branch '2.7':
    Issue bpo-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 bpo-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 bpo-28513: Documented command-line interface of zipfile.
    https://hg.python.org/cpython/rev/843538a4094b

    New changeset 0c8ffa562f3a by Serhiy Storchaka in branch 'default':
    Issue bpo-28513: Documented command-line interface of zipfile.
    https://hg.python.org/cpython/rev/0c8ffa562f3a

    @serhiy-storchaka
    Copy link
    Member Author

    Applied both Martin's suggestion. Thank you all!

    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees

    @serhiy-storchaka serhiy-storchaka

    Labels
    3.7 (EOL) end of life docs Documentation in the Doc dir type-feature A feature request or enhancement
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    4 participants
    @matrixise @vadmium @serhiy-storchaka @zhangyangyu