Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: guardian-related code examples #499

Merged
merged 1 commit into from Jun 19, 2020

Conversation

pmalouin
Copy link
Contributor

Changes

Our public docs do not render properly for some of the guardian endpoints/methods. Some methods are missing:

image

By adding the missing @example tokens, the methods are all documented properly:
image

I also made the indentation uniform across example snippets.

References

Please include relevant links supporting this change such as a:

  • support ticket
  • community post
  • StackOverflow post
  • support forum thread

Testing

You can generate the documentation locally using npm run jsdoc:generate and browsing the resulting docs.

  • This change adds unit test coverage
  • This change adds integration test coverage

Checklist

@pmalouin pmalouin requested a review from a team June 19, 2020 17:56
@lbalmaceda lbalmaceda merged commit b3fd832 into auth0:master Jun 19, 2020
@lbalmaceda lbalmaceda added CH: Fixed documentation This adds, fixes or improves documentation labels Jun 19, 2020
@lbalmaceda lbalmaceda added this to the v2Next milestone Jun 19, 2020
@davidpatrick davidpatrick mentioned this pull request Jun 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CH: Fixed documentation This adds, fixes or improves documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants