Split generation of help extra items and rendering #2517
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.
This:
This is a small refactor of the original
Option.get_help_record()
method, splitting it in two to separate the generation of extra items in help screen and their rendering.This PR:
get_help_record()
the code responsible for extra items generation, and move it to its ownget_help_extra()
methodget_help_record()
as-is, but rely on the newget_help_extra()
method to fetch the extra items to render for the helpget_help_extra()
returns a dictionary of extra items to be rendered, soget_help_record()
can pick them up to render (and translate) them the way it wantsget_help_record()
unittests to inspect values returned byget_help_extra()
Checklist:
CHANGES.rst
summarizing the change and linking to the issue... versionchanged::
entries in any relevant code docs.pre-commit
hooks and fix any issues.pytest
andtox
, no tests failed.