Formatting the argparse CLIs #908
Merged
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 PR adds the possibility to use formatting from
rich-argparse
if the package is installed.It formats all of the CLIs in sisl.
I think this is a very good compromise that could unblock some nice features (#801, basis optimization CLI) that haven't gone in due to discrepancies on what the CLI should look like :) (see #608, #735).
The formatting could be gradually made nicer and nicer by extending the formatter, and nothing about the implementation of the CLIs needs to change.
I don't know whether
rich-argparse
should be a dependency, optional dependency or what. But if it is not a dependency it should be advertised, because it makes things look nicer ✨