Tweak TSDocs for navigation RegExps and modifyURLPrefix #3078
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
malchata
approved these changes
May 9, 2022
Member
malchata
left a comment
malchata
left a comment
There was a problem hiding this comment.
Definitely not a super duper expert on this specific thing, but it reads well to me. So, LGTM!
This was referenced Sep 18, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
R: @tropicadri @malchata
This adds some more documentation that will hopefully help folks avoid the situation that @westonruter found himself in with #3077
It also adds an inline example for the
modifyURLPrefixbuild configuration option, because I realize that what ends up rendered in the final HTML docs is not particularly useful.