docs: fix jsdoc version links and semantics #878
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
ibooker
approved these changes
Mar 31, 2023
scannillo
approved these changes
Apr 3, 2023
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.
Summary
We were getting broken links in the built docs because we have a placeholder for the SDK version that gets swapped out for the actual version at build time. Some of the JSDoc comments are large enough that ended up with more than one version placeholder, thus a basic use of
replacewasn't going to work since it just does the first occurrence.Specifically:
So, a basic regex does the trick.
During this exploration, I also noted that the JSDocs were using incorrect semantic JSDoc syntax. For a bunch of type definitions we were using
@paraminstead of the appropriate@property: https://jsdoc.app/tags-typedef.htmlChecklist
Authors