From e0cde46149f9bcc69aa04b3539e476063aa6ef4f Mon Sep 17 00:00:00 2001 From: Narasimha-sc <166327228+Narasimha-sc@users.noreply.github.com> Date: Thu, 6 Aug 2026 13:34:37 +0000 Subject: [PATCH] bots: document that CreateActiveUser can return a non-active profile The generated docs still said "Create new user profile." with response "ActiveUser: Active user profile", which is no longer true when keepActiveUser is set. The record generator has no per-field description slot, so the command description is the only place a bot author can learn this. --- bots/api/COMMANDS.md | 2 +- bots/src/API/Docs/Commands.hs | 2 +- packages/simplex-chat-client/types/typescript/src/commands.ts | 2 +- .../simplex-chat-python/src/simplex_chat/types/_commands.py | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/bots/api/COMMANDS.md b/bots/api/COMMANDS.md index 476ee4f94d..91a2508125 100644 --- a/bots/api/COMMANDS.md +++ b/bots/api/COMMANDS.md @@ -2004,7 +2004,7 @@ ChatCmdError: Command error (only used in WebSockets API). ### CreateActiveUser -Create new user profile. +Create new user profile. The new profile becomes the active one, unless keepActiveUser is set - in that case the current profile stays active. The response carries the created profile either way, so with keepActiveUser it is not the active profile. *Network usage*: no. diff --git a/bots/src/API/Docs/Commands.hs b/bots/src/API/Docs/Commands.hs index 09ae1faa5b..c9083a8d44 100644 --- a/bots/src/API/Docs/Commands.hs +++ b/bots/src/API/Docs/Commands.hs @@ -178,7 +178,7 @@ chatCommandsDocsData = [ ("ShowActiveUser", [], "Get active user profile.", ["CRActiveUser", "CRChatCmdError"], [], Nothing, "/user"), ( "CreateActiveUser", [], - "Create new user profile.", + "Create new user profile. The new profile becomes the active one, unless keepActiveUser is set - in that case the current profile stays active. The response carries the created profile either way, so with keepActiveUser it is not the active profile.", ["CRActiveUser", "CRChatCmdError"], [TD "CEUserExists" "User or contact with this name already exists", TD "CEInvalidDisplayName" "Invalid user display name"], Nothing, diff --git a/packages/simplex-chat-client/types/typescript/src/commands.ts b/packages/simplex-chat-client/types/typescript/src/commands.ts index 14b03f560f..f6235fb4f9 100644 --- a/packages/simplex-chat-client/types/typescript/src/commands.ts +++ b/packages/simplex-chat-client/types/typescript/src/commands.ts @@ -744,7 +744,7 @@ export namespace ShowActiveUser { } } -// Create new user profile. +// Create new user profile. The new profile becomes the active one, unless keepActiveUser is set - in that case the current profile stays active. The response carries the created profile either way, so with keepActiveUser it is not the active profile. // Network usage: no. export interface CreateActiveUser { newUser: T.NewUser diff --git a/packages/simplex-chat-python/src/simplex_chat/types/_commands.py b/packages/simplex-chat-python/src/simplex_chat/types/_commands.py index f73a4fa4f7..0d30ec0864 100644 --- a/packages/simplex-chat-python/src/simplex_chat/types/_commands.py +++ b/packages/simplex-chat-python/src/simplex_chat/types/_commands.py @@ -652,7 +652,7 @@ def ShowActiveUser_cmd_string(self: ShowActiveUser) -> str: ShowActiveUser_Response = CR.ActiveUser | CR.ChatCmdError -# Create new user profile. +# Create new user profile. The new profile becomes the active one, unless keepActiveUser is set - in that case the current profile stays active. The response carries the created profile either way, so with keepActiveUser it is not the active profile. # Network usage: no. class CreateActiveUser(TypedDict): newUser: "T.NewUser"