From 2522dc18e60e9e2da841a511b1052ad53482fff3 Mon Sep 17 00:00:00 2001 From: Robert Knight Date: Wed, 30 Oct 2024 14:33:39 +0000 Subject: [PATCH] Update `allowLeavingGroups` docs to match reality Update the documentation to match the current behavior. As noted in https://github.com/hypothesis/client/pull/6638, the code comments and behavior were inconsistent. Since changing the behavior is potentially disruptive, that PR changed the comments instead. This commit updates the publisher-facing documentation. --- docs/publishers/config.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/publishers/config.rst b/docs/publishers/config.rst index 1563b333595..61bfdcb3f6f 100644 --- a/docs/publishers/config.rst +++ b/docs/publishers/config.rst @@ -187,7 +187,7 @@ loads. ``boolean``. A flag indicating whether users should be able to leave groups of which they are a member. When `false`, the controls for users to leave - groups will not be provided. (Default: `true`). + groups will not be provided. (Default: `false`). .. option:: enableShareLinks