Add link from each attribute class to conceptual article #6626
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
See dotnet/csharplang#4623 (reply in thread) The conceptual article on these types covers all the attributes, including examples and scenarios for their use. Instead of replicating that, link to it so readers can quickly find all the information they need to annotate their APIs.
ghost added the area-Meta 
333fred approved these changes Apr 10, 2021
gewarren requested changes Apr 12, 2021
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
- add a "Related" tag" - fix typo shown in review comments.
Member Author
| Thanks @gewarren I added the changes you requested. |
| Docs Build status updates of commit cc68f00: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
| Docs Build status updates of commit 9f935d1: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
BillWagner commented Apr 12, 2021
| <summary>Specifies that <see langword="null" /> is allowed as an input even if the corresponding type disallows it.</summary> | ||
| <remarks>To override a method that has a parameter annotated with this attribute, use the <code>?</code> operator. For example: <code>override ISet<Enum> ReadJson(JsonReader reader, Type objectType, ISet<Enum>? existingValue, bool hasExistingValue, JsonSerializer serializer)</code>.</remarks> | ||
| <remarks>To override a method that has a parameter annotated with this attribute, use the <code>?</code> operator. For example: <code>override ISet<Enum> ReadJson(JsonReader reader, Type objectType, ISet<Enum>? existingValue, bool hasExistingValue, JsonSerializer serializer)</code>. For more information, see <see href="/dotnet/csharp/language-reference/attributes/nullable-analysis">Nullable static analysis</see> in the C# guide.</remarks> | ||
| <related type="Article" href="/dotnet/csharp/language-reference/attributes/nullable-analysis">Nullable static analysis</related> |
Member Author
There was a problem hiding this comment.
@gewarren Does this tag need to be under a different parent element? It's not showing up on the review site.
Contributor
There was a problem hiding this comment.
This looks like the correct place. It seems to me you've uncovered a bug: I don't see any See Also sections being rendered for types, e.g. InvalidToolsetDefinitionException. However, I do see one being added for a method overload, and here's the source for that, so it's in the same place. Do you want to log a bug and assign to @mimisasouvanh ?
gewarren approved these changes Apr 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
6 participants
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.
See dotnet/csharplang#4623 (reply in thread)
The conceptual article on these types covers all the attributes, including examples and scenarios for their use. Instead of replicating that, link to it so readers can quickly find all the information they need to annotate their APIs.