Fix broken structure links in documentation #1612
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
jedel1043
changed the title
jedel1043
reviewed
Oct 2, 2021
boa/src/syntax/lexer/token.rs
Outdated
| @@ -108,7 +108,7 @@ pub enum TokenKind { | |||
|
|
|||
| /// A keyword. | |||
| /// | |||
| /// see: [`Keyword`](../keyword/enum.Keyword.html) | |||
| /// see: [`Keyword`](../../ast/keyword/enum.Keyword.html) | |||
There was a problem hiding this comment.
Can you check if using directly Keyword and Punctuator fixes the links? Because IIRC, if the type is imported it should work.
There was a problem hiding this comment.
Actually now that you mention it, it seems that by default rustdoc automatically links the struct inside the enum variant. The additional "see: " is not required".
What I mean is that the green text in the above screenshot already links to the struct. Shall I remove the two explicit links that anyway seem redundant now ?
abhishekc-sharma
force-pushed
the
docs-fix
branch
from
630d091
to
50ec7fa
Compare
jedel1043
added
Hacktoberfest
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.
Found some broken links to some structures when perusing the documentation of Lexer and Parser.