From 23f0c1dbf7951e96323926577173047e3e3cd8eb Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Alejandro=20Gonz=C3=A1lez?= <me@alegon.dev>
Date: Mon, 14 Apr 2025 20:52:01 +0200
Subject: [PATCH] chore: document differences between similar `Credentials`
 methods

---
 packages/app-lib/src/state/minecraft_auth.rs | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/packages/app-lib/src/state/minecraft_auth.rs b/packages/app-lib/src/state/minecraft_auth.rs
index 439030bdb..16a901551 100644
--- a/packages/app-lib/src/state/minecraft_auth.rs
+++ b/packages/app-lib/src/state/minecraft_auth.rs
@@ -404,6 +404,8 @@ impl Credentials {
         )
     }
 
+    /// Like [`get_active`](Self::get_active), but enforces credentials to be
+    /// successfully refreshed unless the network is unreachable or times out.
     #[tracing::instrument]
     pub async fn get_default_credential(
         exec: impl sqlx::Executor<'_, Database = sqlx::Sqlite> + Copy,
@@ -436,6 +438,8 @@ impl Credentials {
         }
     }
 
+    /// Fetches the currently selected credentials from the database, attempting
+    /// to refresh them if they are expired.
     pub async fn get_active(
         exec: impl sqlx::Executor<'_, Database = sqlx::Sqlite> + Copy,
     ) -> crate::Result<Option<Self>> {