Skip to content

Commit

Permalink
docs: be even more specific that owner is ALWAYS required
Browse files Browse the repository at this point in the history
Backports pull request #2112 to 7.1.x maintenance branch; corresponds to
merge commit on master: 0b8a942
  • Loading branch information
dgw committed Jun 28, 2021
1 parent 55facd7 commit cdbefce
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/source/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,13 @@ A Sopel instance must have exactly one owner. This is configured either by
or by :attr:`~CoreSection.owner`. If ``owner_account`` is set, ``owner`` will
be ignored.

.. important::

Even if ``owner_account`` is set, ``owner`` **must** still have a value.

This is silly, we know. The plan for Sopel 8 is to require only one value
or the other.

The same instance can have multiple admins. Similarly, it can be configured
by :attr:`~CoreSection.admin_accounts` or by :attr:`~CoreSection.admins`. If
``admin_accounts`` is set, ``admins`` will be ignored.
Expand All @@ -155,6 +162,9 @@ Example owner & admin configurations::
admin_accounts =
Exirel
HumorBaby
# ignored when owner_account is set,
# but MUST NOT be empty
owner = dgw

Both ``owner_account`` and ``admin_accounts`` are safer to use than
nick-based matching, but the IRC server must support accounts.
Expand Down

0 comments on commit cdbefce

Please sign in to comment.