Docs: Inline CommandArgument required/optional style in template parameter docs #1090
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
|
|
patriksvensson
requested changes
Nov 24, 2022
| @@ -31,7 +31,7 @@ public sealed class CommandArgumentAttribute : Attribute | |||
| /// Initializes a new instance of the <see cref="CommandArgumentAttribute"/> class. | |||
| /// </summary> | |||
| /// <param name="position">The argument position.</param> | |||
| /// <param name="template">The argument template.</param> | |||
| /// <param name="template">The argument template. Wrap in [] for required arguments, <> for optional ones. For example "[MyArgument]".</param> | |||
There was a problem hiding this comment.
Awesome, but it's the other way around.
<> are required, [] are optional.
06528e3 to
84f7bb5
Compare
84f7bb5 to
8ec61b5
Compare
|
@ArveSystad You will need to sign the CLA as well. |
Yea, I know. Keep getting errors from that signing app since yesterday evening: |
|
I've raised an issue over at dotnet-foundation/projects#236. Hopefully it should be resolved soon. I will go ahead and merge your change anyway since its a small change. |
patriksvensson
approved these changes
Nov 25, 2022
|
Merged! Thank you for your contribution. Much appreciated! 👍 |
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.
Found myself looking this up every time I wrote a new command, so it might as well be part of what my IDE shows me while writing.