(chore) align React and Vue docs; align prop/param descriptions #1814
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
|
Hey, here’s your docs preview: https://clerk.com/docs/pr/1814 |
3 tasks
Co-authored-by: Alexis Aguilar <[email protected]>
Co-authored-by: Alexis Aguilar <[email protected]>
Co-authored-by: Alexis Aguilar <[email protected]>
Co-authored-by: Alexis Aguilar <[email protected]>
victoriaxyz
force-pushed
the
vi/align-react-vue-docs
branch
from
237ad8a to
68a0e44
Compare
docs/references/react/use-auth.mdx
Outdated
|
|
||
| The following example demonstrates how to use the `useAuth()` hook to access the current auth state, like whether the user is signed in or not. It also demonstrates a basic example of how you could use the `getToken()` method to retrieve a session token for fetching data from an external resource. | ||
| The following example uses the `useAuth()` hook to fetch data from an external API using a session token. The `getToken()` method is used to retrieve the token. |
There was a problem hiding this comment.
I still wouldn't say this is correct, as per my last comment:
You don't use useAuth() to fetch data using a session token. You use useAuth() to access the getToken() method, which gives you your session token. Then you can use your session token to fetch data
|
|
||
| Use the `useSignUp()` hook to access the `SignUp` object and check the current state of a sign-up. | ||
| The following example uses the `useSignUp()` hook to access the [`SignUp`](/docs/references/javascript/sign-up/sign-up) object and check the current status of a sign-up. |
There was a problem hiding this comment.
let's make this match the usesignin() example description
alexisintech
changed the title
|
we need to merge this PR: #1824 into this one |
alexisintech
approved these changes
Dec 19, 2024
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.
ReturnsandParams headings, and more descriptive example headings<Properties />tableMore resourcessection