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.

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

bpo-34913: Document gzip command line interface #9782

Merged
merged 3 commits into from Oct 10, 2018

Conversation

matrixise
Copy link
Member

@matrixise matrixise commented Oct 9, 2018

Copy link
Member

@tirkarthi tirkarthi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a few minor nits. I will leave it to the reviewers to decide upon the wording. Thanks for the PR :)


Once executed the :mod:`gzip` module keeps the input file(s).

.. versionadded:: 3.8
Copy link
Member

@tirkarthi tirkarthi Oct 10, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The command line interface was present in previous versions too. Maybe this can be changed to versionchanged to indicate argparse is used instead of manual parsing?


.. cmdoption:: -d, --decompress

Uncompress the given file
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can this be changed to decompress? I think it's more aligned with the command line argument being --decompress and also with other parts of the doc where decompress is used.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good catch

----------------------

The :mod:`gzip` module provides a simple command line interface to compress or
uncompress files.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here to use decompress instead of uncompress.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

Copy link
Member

@tirkarthi tirkarthi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks for making the changes :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants