Handle exessively long help text for jobs. #1802
Open
+35
−22
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.
Currently, long (especially multi-line) text in the
help =
property ofJob
classes mess up the job listings (manage.py runjob -l
):this PR, by default, extracts an 80 character digest and uses the
rich
library to output the listing as a table:or, if verbosity is set to 2 or higher (
manage.py runjob -l -v2
) outputs the entire help text, but formatted a little better:As an added feature,
rich
will render any console markup (https://rich.readthedocs.io/en/latest/markup.html) present in the help text.