Add note to always use positional args first #15761
Closed
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
AbrilRBS
commented
Feb 27, 2024
AbrilRBS
changed the title
memsharded
reviewed
Mar 4, 2024
Comment on lines
+125
to
+127
| formatted_help += ("\nNOTE: Use always positional parameters first\n" | ||
| " conan <command> <positional args> [optional args]\n") | ||
| return formatted_help |
There was a problem hiding this comment.
Suggested change
| formatted_help += ("\nNOTE: Use always positional parameters first\n" | |
| " conan <command> <positional args> [optional args]\n") | |
| return formatted_help | |
| lines = formatted_help.splitlines() | |
| note = ("\nNOTE: Use always positional parameters first\n" | |
| " conan <command> <positional args> [optional args]\n") | |
| lines.insert(lines.index(""), note) | |
| return "\n".join(lines) |
I tried it, but I was not convinced, as it shows at the very end, not very visible when there are arguments.
Then I tried this, it seems it would be a bit better IMHO.
Still, it is also missing in the short usage error when some arg is missing or incorrect. This can be solved by adding the format_usage() method too.
All in all, seems a bit too dirty/too much for a known Python bug: python/cpython#53584
Not sure what would be the best approach to be honest.
There was a problem hiding this comment.
Let's just make sure we mention it somewhere in the docs then!
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.
This adds a note to let the user know they should set positional args first in commands