Format help strings #104
Merged
Format help strings #104
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Intent is to make spacing consistent for short and long options. Signed-off-by: John Pennycook <john.pennycook@intel.com>
Hopefully more readable and maintainable than manually inserting seemingly magic newlines and spaces. Signed-off-by: John Pennycook <john.pennycook@intel.com>
Uses backspace character (\b) because argparse does not provide any way to override the amount of indentation. Although argparse.HelpFormatter exposes an option for the amount of indendation, it is undocumented and not part of the public interface. Signed-off-by: John Pennycook <john.pennycook@intel.com>
laserkelvin
approved these changes
Aug 30, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Related issues
Closes #45.
Proposed changes
_help_stringfunction to consistently format help strings.\nand\bcharacters in the right places to adjustargparseformatting.This might look like a bit of a hack, but all other solutions I could find to this problem rely on creating a subclass of
HelpFormatterthat relies on undocumented behavior.