Conversation
Widcket
commented
Dec 14, 2021
| - scope: Scope value requested when authenticating the user. Default is `openid profile email`. | ||
| - Returns: Authentication request that will yield Auth0 user's credentials. | ||
| - Requires: Passwordless OTP Grant `http://auth0.com/oauth/grant-type/passwordless/otp`. Check [our documentation](https://auth0.com/docs/configure/applications/application-grant-types) for more info and how to enable it. | ||
| */ |
Contributor
Author
There was a problem hiding this comment.
These get rendered duplicated.
Contributor
|
I noticed that the code in the drop downs on the README isn't being highlighted, looks like an issue with jazzy
|
Contributor
Author
Yup, that's a known issue: realm/jazzy#1116 |
adamjmcgrath
approved these changes
Dec 14, 2021
Member
|
Looks cool |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Changes
This PR sets up the API docs generation with Jazzy, and raises the documentation coverage to 92% of the public API surface area.
The command that generates the docs (
bundle exec jazzy) was added to the.shiprcfile to generate the docs when creating a release PR.The initial generated docs will be added in a future PR.
Testing
Checklist