fix: guardian-related code examples #499
Merged
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.
Changes
Our public docs do not render properly for some of the guardian endpoints/methods. Some methods are missing:
By adding the missing
@example
tokens, the methods are all documented properly:I also made the indentation uniform across example snippets.
References
Please include relevant links supporting this change such as a:
Testing
You can generate the documentation locally using
npm run jsdoc:generate
and browsing the resulting docs.Checklist