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

Add -h alias for --help option #1163

Merged
merged 7 commits into from
Jun 17, 2020
Merged

Add -h alias for --help option #1163

merged 7 commits into from
Jun 17, 2020

Conversation

jan25
Copy link
Contributor

@jan25 jan25 commented Jun 14, 2020

Add shortcut option for help to support pip-compile|sync -h

Changelog-friendly one-liner: Add -h alias for --help option

Contributor checklist
  • Provided the tests for the changes.
  • Gave a clear one-line description in the PR (that the maintainers can add to CHANGELOG.md on release).
  • Assign the PR to an existing or new milestone for the target version (following Semantic Versioning).

@codecov
Copy link

codecov bot commented Jun 14, 2020

Codecov Report

Merging #1163 into master will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1163   +/-   ##
=======================================
  Coverage   99.50%   99.50%           
=======================================
  Files          36       36           
  Lines        2839     2839           
  Branches      333      333           
=======================================
  Hits         2825     2825           
  Misses          8        8           
  Partials        6        6           
Impacted Files Coverage Δ
piptools/scripts/compile.py 100.00% <100.00%> (ø)
piptools/scripts/sync.py 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5865cd1...1b9dfa4. Read the comment docs.

Copy link
Member

@atugushev atugushev left a comment

Choose a reason for hiding this comment

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

Hello @jan25,

Thanks for your contribution! Looks good. I'd prefer to pass the dict directly to the command(). See the suggestions below. Let me know what you think.

piptools/scripts/compile.py Outdated Show resolved Hide resolved
piptools/scripts/sync.py Outdated Show resolved Hide resolved
piptools/scripts/compile.py Outdated Show resolved Hide resolved
piptools/scripts/sync.py Outdated Show resolved Hide resolved
@atugushev atugushev added cli Related to command line interface things enhancement Improvements to functionality labels Jun 15, 2020
jan25 and others added 4 commits June 15, 2020 18:49
Co-authored-by: Albert Tugushev <albert@tugushev.ru>
Co-authored-by: Albert Tugushev <albert@tugushev.ru>
Co-authored-by: Albert Tugushev <albert@tugushev.ru>
Co-authored-by: Albert Tugushev <albert@tugushev.ru>
@jan25
Copy link
Contributor Author

jan25 commented Jun 15, 2020

@atugushev thanks for the review. I like your idea of passing dict value as named arg, so accepted suggestions.

Copy link
Member

@atugushev atugushev left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@atugushev atugushev added this to the 5.3.0 milestone Jun 16, 2020
@atugushev atugushev merged commit e49c10d into jazzband:master Jun 17, 2020
@atugushev
Copy link
Member

atugushev commented Jun 17, 2020

@jan25

Nice first contribution! 🎉 Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cli Related to command line interface things enhancement Improvements to functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants