lsd-rs / lsd

The next gen ls command
Apache License 2.0
12.8k stars 413 forks source link

Fix clap doc-comment #1045

Closed Long0x0 closed 4 weeks ago

Long0x0 commented 2 months ago

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

muniu-bot[bot] commented 2 months ago

[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: - **[OWNERS](https://github.com/lsd-rs/lsd/blob/master/OWNERS)** Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment
outloudvi commented 1 month ago

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).

zwpaper commented 4 weeks ago

thanks so much for this good and funny catch @outloudvi