Docs: make sure it's hard to miss that type name has to match #955
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
|
I think it would be better to actually use the attribute rather than to have it there but commented out. |
Some people (me) doesn't read the full page or just gloss over the naming section. It's a lot of wasted time debugging the issue when the type name is not matching, adding name attribute to the examples makes it really hard to miss.
vargad
force-pushed
the
docs_make_name_match_requirement_more_apparent
branch
from
9a6221c
to
79151c5
Compare
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.
Some people (me) doesn't read the full page or just gloss over the naming section. It's a lot of wasted time debugging the issue when the type name is not matching, adding name attribute to the examples makes it really hard to miss.
Closes #940