Fix broken annotation links #119
Merged
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
Several places link to `/docs/syntax#annotations`, but that anchor doesn't exist. Also the syntax page doesn't define or introduce annotations. After giving a rationale and example, it does hint that they are called annotations when it says "Annotation syntax also works with tags", but they should have been introduced before then. This commit moves the annotations description out of Attributes by adding a new Annotations header (on the Syntax page), and tweaks the opening sentence to give a name to what it's describing. So now the links work and readers know what annotations are.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
|
mfix-stripe
approved these changes
Apr 17, 2024
|
Thanks @pjungwir! |
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.
Several places link to
/docs/syntax#annotations, but that anchor doesn't exist. Also the syntax page doesn't define or introduce annotations. After giving a rationale and example, it does hint that they are called annotations when it says "Annotation syntax also works with tags", but they should have been introduced before then.This commit moves the annotations description out of Attributes by adding a new Annotations header (on the Syntax page), and tweaks the opening sentence to give a name to what it's describing. So now the links work and readers know what annotations are.