From f48273b8b104cfa7275dca1083853c35a299de1b Mon Sep 17 00:00:00 2001 From: dgw Date: Wed, 29 Nov 2023 15:54:29 -0600 Subject: [PATCH] config.core_section: fix documentation of `logdir` option It is relative to the config's `homedir`, which is the config's parent folder by default but can be changed. While I was here: Added a note indicating why one might want to change the `homedir` setting, for example to match service-unit conventions. --- sopel/config/core_section.py | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/sopel/config/core_section.py b/sopel/config/core_section.py index 4f91cac44..c4e5e6110 100644 --- a/sopel/config/core_section.py +++ b/sopel/config/core_section.py @@ -756,8 +756,11 @@ class CoreSection(StaticSection): def homedir(self): """The directory in which various files are stored at runtime. - By default, this is the same directory as the config file. It cannot be - changed at runtime. + Specifying the ``homedir`` option is useful for e.g. :doc:`running Sopel + as a system service `. + + If not set, the config file's parent directory will be used. This value + cannot be changed at runtime. """ return self._parent.homedir @@ -824,7 +827,7 @@ def homedir(self): :default: ``logs`` If the given value is not an absolute path, it will be interpreted relative - to the directory containing the config file with which Sopel was started. + to the :attr:`homedir` of the config file with which Sopel was started. .. seealso::