From cb052a9b0846048feef18080d830cc36a9ed7282 Mon Sep 17 00:00:00 2001
From: Joel Lee <lee.yi.jie.joel@gmail.com>
Date: Mon, 21 Oct 2024 09:43:47 +0200
Subject: [PATCH] fix: update soft-deletion docs (#973)

## What kind of change does this PR introduce?

For clarity as it seems to be confusing users. Ticket linked internally.
---
 src/GoTrueAdminApi.ts | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/GoTrueAdminApi.ts b/src/GoTrueAdminApi.ts
index 8f4ee2ba7..79f198395 100644
--- a/src/GoTrueAdminApi.ts
+++ b/src/GoTrueAdminApi.ts
@@ -260,7 +260,7 @@ export default class GoTrueAdminApi {
    * Delete a user. Requires a `service_role` key.
    *
    * @param id The user id you want to remove.
-   * @param shouldSoftDelete If true, then the user will be soft-deleted (setting `deleted_at` to the current timestamp and disabling their account while preserving their data) from the auth schema.
+   * @param shouldSoftDelete If true, then the user will be soft-deleted from the auth schema. Soft deletion allows user identification from the hashed user ID but is not reversible.
    * Defaults to false for backward compatibility.
    *
    * This function should only be called on a server. Never expose your `service_role` key in the browser.