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

Projects
None yet
5 participants
@matrixise
Contributor

matrixise commented Oct 9, 2018

@tirkarthi

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

This comment has been minimized.

@tirkarthi

tirkarthi Oct 10, 2018

Contributor

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

This comment has been minimized.

@tirkarthi

tirkarthi Oct 10, 2018

Contributor

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.

This comment has been minimized.

@matrixise

matrixise Oct 10, 2018

Contributor

good catch

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

This comment has been minimized.

@tirkarthi

tirkarthi Oct 10, 2018

Contributor

Same here to use decompress instead of uncompress.

This comment has been minimized.

@matrixise

matrixise Oct 10, 2018

Contributor

fixed

@tirkarthi

LGTM. Thanks for making the changes :)

@JulienPalard JulienPalard merged commit 7c817e6 into python:master Oct 10, 2018

5 checks passed

Azure Pipelines PR #20181010.6 succeeded
Details
bedevere/issue-number Issue number 34913 found
Details
bedevere/news News entry found in Misc/NEWS.d
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

yahya-abou-imran added a commit to yahya-abou-imran/cpython that referenced this pull request Nov 2, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment