search

nedbat / scriv

Changelog management tool
https://scriv.readthedocs.io
Apache License 2.0
260 stars 29 forks source link

[Bug] Minor Visual Bug: `collect` Description Truncated in `--help` Text #63

Closed kevinmatthes closed 2 years ago

kevinmatthes commented 2 years ago

Hello, @nedbat,

First of all, thank you for your tool!

When trying to set up Scriv for one of my repositories, I encountered a minor visual bug in the --help text of the application. When calling

scriv --help

with the latest version, v0.17.0, installed from the Python Package Index, the description of the subcommand collect is truncated; see line 12:

Usage: scriv [OPTIONS] COMMAND [ARGS]...

  Manage changelogs.

  Version 0.17.0

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  collect         Collect fragments and produce a combined entry in the...
  create          Create a new scriv changelog fragment.
  github-release  Create or update GitHub releases from the changelog.

This is neither a critical nor an urgent bug, it is just reported for completeness.

nedbat commented 2 years ago

Sadly, click has an issue about this behavior which has been closed and locked without a real answer: https://github.com/pallets/click/issues/486

kevinmatthes commented 2 years ago

Thank you for the link! I have found the answer which I am going to submit in a new Pull Request.

kevinmatthes commented 2 years ago

https://github.com/pallets/click/issues/486#issuecomment-185790528 is a workaround which I submitted as #65 -- with a changelog entry, of course.

nedbat commented 2 years ago

Fixed in e7500f3.