Document the id attribute for example nodes
#630
Merged
Conversation
This file contains 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
baronfel
commented
Sep 8, 2021
|
|
||
| The `example` XML documentation element is not specified to accept an `id` attribute for purposes of uniquely identifying an | ||
| example, but doing so allows tooling to deep-link to a specific example and so should be encouraged. `id` attributes _should_ | ||
| be url-safe by default, and _should_ be unique across a library. |
There was a problem hiding this comment.
@dsyme question about guidance here: what level of uniqueness scope is enough? Should tools ensure uniqueness via namespacing, or should users ensure uniqueness via naming on their own?
There was a problem hiding this comment.
fsdocs isn't exactly great about diagnostics and error failures
I guess it should be "warn if strict is not on, error if it is"
This was referenced Sep 8, 2021
dsyme
approved these changes
Sep 9, 2021
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.
Click “Files changed” → “⋯” → “View file” for the rendered RFC.