Order of arguments good practise #3760
Merged
Conversation
This file contains hidden or 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
Jun 5, 2024
memsharded
approved these changes
Jun 5, 2024
memsharded
reviewed
Jun 5, 2024
knowledge/guidelines.rst
Outdated
Comment on lines
46
to
48
| - Named arguments which receive a value should use ``=`` without spaces. For example, ``-r=conancenter`` is correct, but ``-r conancenter`` is not. | ||
| - Positional arguments when invoking Conan should be specified first, before any named argument. For example, | ||
| ``conan install . -s="os=Windows"`` is correct, but ``conan install -s="os=Windows" .`` is not. |
There was a problem hiding this comment.
Not fully sure. The -r conancenter does work, so maybe we want to reword a bit? I'd do:
- Use just 1 item to define both good practices for CLI args, not 2 bullet items
- Define the good practice without saying that the other is not correct (positive recommendation), just recommend one over the other (it can be said that there can be arg parsing errors if not in some cases)
memsharded
approved these changes
Jun 5, 2024
czoido
approved these changes
Jul 2, 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.
Closes #3629