From d1d35f2f0462d80fd96157cce0cbe9ed9181eda6 Mon Sep 17 00:00:00 2001 From: Mike Wilson Date: Thu, 16 Oct 2025 15:57:34 -0400 Subject: [PATCH] Make wording for persistence options more clear in docs --- doc/admin.rst | 12 +++++------- doc/user.rst | 13 +++++++------ 2 files changed, 12 insertions(+), 13 deletions(-) diff --git a/doc/admin.rst b/doc/admin.rst index ec80112..08ef2f2 100644 --- a/doc/admin.rst +++ b/doc/admin.rst @@ -147,18 +147,16 @@ any other IRC server. persistent_by_default ~~~~~~~~~~~~~~~~~~~~~ -If this option is set to `true`, all rooms will be persistent by default: +If this option is set to "true", all rooms will be persistent by default: the value of the “persistent” option in the global configuration of each user will be “true”, but the value of each individual room will still -default to false. This means that a user just needs to change the global -“persistent” configuration option to false in order to override this. +default to "false". This means that a user just needs to change their global +“persistent” configuration option to "false" in order to override this +and be able to set rooms to not persistent. -If it is set to false (the default value), all rooms are not persistent by +If this option is set to "false" (the default value), all rooms are not persistent by default. -Each room can be configured individually by each user, to override this -default value. See :ref:`Ad-hoc commands`. - realname_customization ~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/user.rst b/doc/user.rst index 023036a..065d9f0 100644 --- a/doc/user.rst +++ b/doc/user.rst @@ -399,12 +399,13 @@ The provided configuration form contains these fields: the database. - **Max history length**: The maximum number of lines in the history that the server is allowed to send when joining a channel. -- **Persistent**: Overrides the value specified in each individual - channel. If this option is set to true, all channels are persistent, - whether or not their specific value is true or false. This option is true - by default for everyone if the `persistent_by_default` configuration - option is true, otherwise it’s false. See below for more details on what a - persistent channel is. +- **Persistent**: If this option is set to true, the persistence setting + specified on each individual channel is ignored and all channels are persistent. + If this option is set to false, the persistence setting specified on each + individual channel is respected. + This option defaults to the value of :ref:`persistent_by_default`, which itself + defaults to false. + See below for more details on what a persistent channel is. On a server JID ~~~~~~~~~~~~~~~