From e152f1732215be27133f6c21bfd05079985dfa06 Mon Sep 17 00:00:00 2001 From: Isaac Harris-Holt Date: Sun, 22 Dec 2024 13:32:29 +0000 Subject: [PATCH] docs update --- src/pevensie/auth.gleam | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/src/pevensie/auth.gleam b/src/pevensie/auth.gleam index af87083..6546f36 100644 --- a/src/pevensie/auth.gleam +++ b/src/pevensie/auth.gleam @@ -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 @@ -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,