Merge pull request #1088 from lens-protocol/fix/tsdoc

fix: switchAccount action doc
lens-protocol · Feb 28, 2025 · 2a77f49 · 2a77f49
2 parents 6a64375 + 21bdf92
commit 2a77f49
Showing 1 changed file with 4 additions and 7 deletions.
diff --git a/packages/client/src/actions/authentication.ts b/packages/client/src/actions/authentication.ts
@@ -129,15 +129,12 @@ export function legacyRolloverRefresh(
 }
 
 /**
- * Switch to account managed.
+ * Switch to another managed account.
  *
- * ```ts
- * const result = await switchAccount(sessionClient, {
- *   account: evmAddress('0x90c8c68d0Abfb40D4fCD72316A65e42161520BC3'),
- * });
- * ```
+ * @remarks Use the {@link SessionClient#switchAccount} method to switch to an account instead.
+ * It's unlikely you'll need to use this action directly.
  *
- * @param client - The session client for the authenticated Account.
+ * @param client - The current session client.
  * @param request - The query request.
  * @returns The authenticated tokens for the switched account.
  */