Skip to content

Commit 4249861

Browse files
committed
fixup changelog
1 parent 77ee653 commit 4249861

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

CHANGELOG.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,11 @@
33
## 2.1.0 (unreleased)
44

55
* Add automation support to `blurb add` command:
6-
* New `--gh_issue` option to specify GitHub issue number
6+
* New `--gh-issue` option to specify GitHub issue number
77
* New `--section` option to specify NEWS section
8-
* New `--rst_on_stdin` option to read entry content from stdin
8+
* New `--rst-on-stdin` option to read entry content from stdin
99
* Useful for CI systems and automated tools
10+
* Uses `cyclopts` for command line parsing instead of rolling our own to reduce our code size, this changes the help format and brings in a dependency.
1011

1112
## 2.0.0
1213

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -83,10 +83,10 @@ For automated tools and CI systems, `blurb add` supports non-interactive operati
8383

8484
```bash
8585
# Add a blurb entry from stdin
86-
echo "Added beans to the :mod:`spam` module." | blurb add \
87-
--gh_issue 123456 \
86+
echo 'Added beans to the :mod:`spam` module.' | blurb add \
87+
--gh-issue 123456 \
8888
--section Library \
89-
--rst_on_stdin
89+
--rst-on-stdin
9090
```
9191

9292
When using `--rst_on_stdin`, both `--gh_issue` and `--section` are required.

0 commit comments

Comments
 (0)