Skip to content

Commit

Permalink
docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
isaacharrisholt committed Dec 22, 2024
1 parent 7b7172d commit e152f17
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions src/pevensie/auth.gleam
Original file line number Diff line number Diff line change
Expand Up @@ -270,9 +270,8 @@ pub opaque type PevensieAuth(driver, driver_error, user_metadata, connected) {

/// Creates a new [`PevensieAuth`](#PevensieAuth) instance.
///
/// The `driver` argument is the driver to use for authentication. This
/// should be the driver that you've created using the `new_auth_driver`
/// function.
/// The `driver` argument is the driver to use for authentication. Use either
/// a driver provided by Pevensie, or any third-party driver you like.
///
/// The `user_metadata_decoder` and `user_metadata_encoder` arguments are
/// used to decode and encode user metadata. These should be the inverse
Expand Down Expand Up @@ -343,6 +342,9 @@ pub fn connect(

/// Runs teardown for your chosen auth driver and returns a disconnected
/// [`PevensieAuth`](#PevensieAuth) instance.
///
/// After calling this function, you can no longer use the auth driver
/// unless you call [`connect`](#connect) again.
pub fn disconnect(
pevensie_auth: PevensieAuth(
auth_driver,
Expand Down

0 comments on commit e152f17

Please sign in to comment.