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

Document pep next in --help #53

Merged
merged 1 commit into from
Nov 29, 2023
Merged

Document pep next in --help #53

merged 1 commit into from
Nov 29, 2023

Conversation

hugovk
Copy link
Owner

@hugovk hugovk commented Nov 29, 2023

Fixes #52.

Before

pep --help
usage: pep [-h] [-u URL] [-p PR] [--clear-cache] [-n] [-v] [-V] [search ...]

pepotron: CLI to open PEPs in your browser

positional arguments:
  search             PEP number, or Python version for its schedule, or words
                     from title

options:
  -h, --help         show this help message and exit
  -u URL, --url URL  Base URL for PEPs (default: https://peps.python.org)
  -p PR, --pr PR     Open preview for python/peps PR
  --clear-cache      Clear cache before running
  -n, --dry-run      Don't open in browser
  -v, --verbose      Verbose logging
  -V, --version      show program's version number and exit

After

pep --help
usage: pep [-h] [-u URL] [-p PR] [--clear-cache] [-n] [-v] [-V] [search ...]

pepotron: CLI to open PEPs in your browser

positional arguments:
  search             PEP number, or Python version for its schedule, or words
                     from title, or 'next' to find next available PEP number

options:
  -h, --help         show this help message and exit
  -u URL, --url URL  Base URL for PEPs (default: https://peps.python.org)
  -p PR, --pr PR     Open preview for python/peps PR
  --clear-cache      Clear cache before running
  -n, --dry-run      Don't open in browser
  -v, --verbose      Verbose logging
  -V, --version      show program's version number and exit

@hugovk hugovk added the changelog: Fixed For any bug fixes label Nov 29, 2023
@hugovk hugovk changed the title Document 'pep next' in --help Document pep next in --help Nov 29, 2023
Copy link

codecov bot commented Nov 29, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (bf85233) 99.14% compared to head (3213149) 99.14%.
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #53   +/-   ##
=======================================
  Coverage   99.14%   99.14%           
=======================================
  Files           4        4           
  Lines         233      233           
=======================================
  Hits          231      231           
  Misses          2        2           
Flag Coverage Δ
macos-latest 99.14% <ø> (ø)
ubuntu-latest 99.14% <ø> (ø)
windows-latest 99.14% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@hugovk hugovk added the documentation Improvements or additions to documentation label Nov 29, 2023
@vstinner
Copy link

I would prefer sub-commands such as:

pepotron search "interpreter"
pepotron next

@hugovk
Copy link
Owner Author

hugovk commented Nov 29, 2023

Hmm, something to consider for the future. I'll merge this now, it improves the current situation.

@hugovk hugovk merged commit 292fd25 into main Nov 29, 2023
48 checks passed
@hugovk hugovk deleted the docs-help-next branch November 29, 2023 16:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog: Fixed For any bug fixes documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

next command is not documented in --help
2 participants