-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Consistently xref properties in ArgumentException #174
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
Conversation
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.
Thanks for replacing fenced text with links, @ChrisMaddock. One of the links is broken, though -- ParamName is a property of ArgumentException, not Exception.
xml/System/ArgumentException.xml
Outdated
| |`Message`|The error message string.| | ||
| |`ParamName`|The parameter name string.| | ||
| |<xref:System.Exception.Message%2A>|The localized error message string.| | ||
| |<xref:System.Exception.ParamName%2A>|The parameter name string.| |
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.
This should be <xref:System.ArgumentException.ParamName%2A>
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.
Thanks @rpetrusha - good spot!
Now you've pointed it out - I've noticed the other xref's are inconsistent in the file. Some reference <xref:System.ArgumentException.Message%2A>, others <xref:System.Exception.Message%2A>. Should they all be referencing ArgumentException, or does it not matter?
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.
That's a good question, @ChrisMaddock . They actually all should reference ArgumentException, since it overrides the base class Exception.Message.
|
CLA seems stuck. |
|
@rpetrusha Additional changes made - would you be able to take another look? Thanks for the clarification here. 😄 |
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.
Thanks for making all of the additional changes, @ChrisMaddock. This looks really good. We'll merge once the build completes.
Properties in the remarks section of this API page were inconsistently fenced/xref'd. I assume there's no problem xref'ing everything!