-
Notifications
You must be signed in to change notification settings - Fork 4.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Make it clear the subset flag can be omitted #47691
Make it clear the subset flag can be omitted #47691
Conversation
Hello @SingleAccretion, while I agree that the subset is implicit, this is only the case when it is the first argument so I believe it is intentional that our docs are in the verbose format. If anything, I think we should only mention in the subset parameter that if it is the first item, you can omit it (which we might already have this mention). @ViktorHofer thoughts? |
I suspected as much, yes. I agree that it would probably be better to just point out that the flag can be omitted, and this is indeed mentioned in various places (notably, all examples in What lead me to do it this way is the fact that, having pointed a person new to |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm fine with either merging this or not but FWIW I would prefer a consistent style in our docs. I doubt that coreclr's README.md is the only place that uses the explicit subset style.
Other docs use the explicit style. I will revert the changes and just mention the flag can be omitted. |
FWIW I think the implicit style makes more sense as I don't see a reason why the subset wouldn't be the first param. |
Thanks for the contribution @SingleAccretion ! |
It is not necessary to explicitly specify the subset flag when building.