Update documentation for the signup action (#757)

* Update documentation for signup()

* Update wording based on feedback

Co-authored-by: sgarcia <sgarcia@pop-os.localdomain>
This commit is contained in:
Steven Garcia 2022-10-14 09:10:51 -05:00 committed by GitHub
parent 8cd5220293
commit 76e1cf026f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -839,6 +839,7 @@ The quickest way to get started is by using the following API generated by Wasp:
- Signup and Login forms at `@wasp/auth/forms/Signup` and `@wasp/auth/forms/Login` routes
- `logout` function
- `useAuth()` React hook
**NOTE:** If the signup is successful, the Signup form will automatically log in the user.
Check our [Todo app tutorial](/docs/tutorials/todo-app/auth) to see how it works. See below for detailed specification of each of these methods.
@ -909,7 +910,7 @@ Login is a regular action and can be used directly from the frontend.
### `signup()`
An action for signing in in the user.
An action for signing up the user. This action does not log in the user, you still need to call `login()`.
```js
signup(userFields)
```