lsd icon indicating copy to clipboard operation
lsd copied to clipboard

Fix clap doc-comment

Open Long0x0 opened this issue 1 year ago • 1 comments

clap always removes the last single period from a doc-comment.

before:

~$ lsd --help
  -a, --all                          Do not ignore entries starting with

after:

~$ lsd --help
  -a, --all                          Do not ignore entries starting with .

TODO

  • [x] Use cargo fmt
  • [ ] Add necessary tests
  • [ ] Update default config/theme in README (if applicable)
  • [ ] Update man page at lsd/doc/lsd.md (if applicable)

Long0x0 avatar May 08 '24 11:05 Long0x0

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Long0x0 Once this PR has been reviewed and has the lgtm label, please assign zwpaper for approval by writing /assign @zwpaper in a comment. For more information see:The Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment Approvers can cancel approval by writing /approve cancel in a comment

muniu-bot[bot] avatar May 08 '24 11:05 muniu-bot[bot]

To fix this, Clap also has a flag called verbatim_doc_comment to avoid removing trailing dots and so on, but solution of this PR seems more specific (and not breaking other benefits of Clap's pre-processing).

outloudvi avatar May 25 '24 13:05 outloudvi

thanks so much for this good and funny catch @outloudvi

zwpaper avatar Jun 08 '24 07:06 zwpaper