Infer short completion descriptions for commandline flags #7804
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Descriptions for commandline flags may not include newlines and should be rather short for display in a shell.
The current completion code asserts that a description does not contain newlines.
Current descriptions for e.g.
-I
trigger that assertion and break commandline flag completion.Context
See #7792
Here I shorten the description by truncating the string on
'\n'
or'.'
to and add an ellipsis' [...]'
if sensible.I chose to split on
\n
as well as.
to keep the descriptions a single sentence.I also had to trim at least an empty line from the front of the string to make
-I
work.This yields something like the following for
fish
:Checklist for maintainers
Maintainers: tick if completed or explain if not relevant
tests/**.sh
src/*/tests
tests/nixos/*