-
Notifications
You must be signed in to change notification settings - Fork 4.8k
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
Update TagName docs to include behavior if tag is not found #109934
Conversation
Adds documentation to TagList.IndexOf that states the behavior when the key was not found.
Adds documentation to TagList.IndexOf that states the behavior when the key was not found.
@dotnet-policy-service agree company="Microsoft" |
For reference, existing docs are here: https://github.com/dotnet/dotnet-api-docs/blob/46669e697cfde9887769092e3bc42d1fcc475586/xml/System.Diagnostics/TagList.xml#L446 and they do mention a bit more detail, but not the I think we'll need to port the changes made here to the api-docs, unless we enable I wonder if there are other |
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.
And yes, until this assembly is marked to use the compiler generated XML file, this change won't automatically be reflected in online docs.
/ba-g the iOS failure is not related. CC @matouskozak if want to look. |
@mpdelbuono thanks for submitting this PR. Is it possible you can help submit a PR to port it to the public docs? basically, you need to change the following file: |
Adds detail to the documentation of
TagName.IndexOf
to clarify that the method will return -1 if the specified tag was not found.(No behavior change; this is a documentation change only.)