Update README #15

Merged
torjus merged 1 commits from 14-readme into master 2024-10-07 20:07:30 +00:00
2 changed files with 19 additions and 8 deletions
Showing only changes of commit a27f88a62b - Show all commits

View File

@ -5,15 +5,26 @@ Nixpkgs PR status checker.
## Example
```console
$ nixprstatus 345501
$ nixprstatus pr 345501
ktailctl: 0.18.0 -> 0.18.1
✅ merged
✅ master
nixos-unstable-small
nixos-unstable
nixos-unstable-small
nixos-unstable
❌ nixos-24.05
$ nixprstatus --help
Usage: python -m nixprstatus [OPTIONS] COMMAND [ARGS]...
Options:
--install-completion Install completion for the current shell.
--show-completion Show completion for the current shell, to copy it or
customize the installation.
--help Show this message and exit.
Commands:
pr Get merge status of pull request.
since Return the count of commits that has happened between the two refs.
```
## TODO
* Support backported commits
* JSON output

View File

@ -21,7 +21,7 @@ def pr(
list[str] | None, typer.Option(help="Check specific branch")
] = None,
):
"""Get status of pull request"""
"""Get merge status of pull request."""
console = Console()
if branches: