From 2375eb137d03cdab186ef64b71b6fb31777f1f68 Mon Sep 17 00:00:00 2001 From: rladenson Date: Fri, 8 Nov 2024 19:12:16 -0700 Subject: [PATCH] docs: document banner privacy --- PluralKit.Bot/Commands/Groups.cs | 4 ++-- PluralKit.Bot/Commands/MemberEdit.cs | 2 +- PluralKit.Bot/Commands/SystemEdit.cs | 2 +- docs/content/user-guide.md | 4 ++++ 4 files changed, 8 insertions(+), 4 deletions(-) diff --git a/PluralKit.Bot/Commands/Groups.cs b/PluralKit.Bot/Commands/Groups.cs index b0ac3276..e442401e 100644 --- a/PluralKit.Bot/Commands/Groups.cs +++ b/PluralKit.Bot/Commands/Groups.cs @@ -509,13 +509,13 @@ public class Groups .Title($"Current privacy settings for {target.Name}") .Field(new Embed.Field("Name", target.NamePrivacy.Explanation())) .Field(new Embed.Field("Description", target.DescriptionPrivacy.Explanation())) - .Field(new Embed.Field("Description", target.BannerPrivacy.Explanation())) + .Field(new Embed.Field("Banner", target.BannerPrivacy.Explanation())) .Field(new Embed.Field("Icon", target.IconPrivacy.Explanation())) .Field(new Embed.Field("Member list", target.ListPrivacy.Explanation())) .Field(new Embed.Field("Metadata (creation date)", target.MetadataPrivacy.Explanation())) .Field(new Embed.Field("Visibility", target.Visibility.Explanation())) .Description( - $"To edit privacy settings, use the command:\n> pk;group **{target.Reference(ctx)}** privacy **** ****\n\n- `subject` is one of `name`, `description`, `icon`, `members`, `metadata`, `visibility`, or `all`\n- `level` is either `public` or `private`.") + $"To edit privacy settings, use the command:\n> pk;group **{target.Reference(ctx)}** privacy **** ****\n\n- `subject` is one of `name`, `description`, `banner`, `icon`, `members`, `metadata`, `visibility`, or `all`\n- `level` is either `public` or `private`.") .Build()); return; } diff --git a/PluralKit.Bot/Commands/MemberEdit.cs b/PluralKit.Bot/Commands/MemberEdit.cs index 9080c814..c9fc943b 100644 --- a/PluralKit.Bot/Commands/MemberEdit.cs +++ b/PluralKit.Bot/Commands/MemberEdit.cs @@ -765,7 +765,7 @@ public class MemberEdit target.MetadataPrivacy.Explanation())) .Field(new Embed.Field("Visibility", target.MemberVisibility.Explanation())) .Description( - "To edit privacy settings, use the command:\n`pk;member privacy `\n\n- `subject` is one of `name`, `description`, `avatar`, `birthday`, `pronouns`, `proxies`, `metadata`, `visibility`, or `all`\n- `level` is either `public` or `private`.") + "To edit privacy settings, use the command:\n`pk;member privacy `\n\n- `subject` is one of `name`, `description`, `banner`, `avatar`, `birthday`, `pronouns`, `proxies`, `metadata`, `visibility`, or `all`\n- `level` is either `public` or `private`.") .Build()); return; } diff --git a/PluralKit.Bot/Commands/SystemEdit.cs b/PluralKit.Bot/Commands/SystemEdit.cs index 7a05af1d..264761ec 100644 --- a/PluralKit.Bot/Commands/SystemEdit.cs +++ b/PluralKit.Bot/Commands/SystemEdit.cs @@ -842,7 +842,7 @@ public class SystemEdit .Field(new Embed.Field("Current fronter(s)", target.FrontPrivacy.Explanation())) .Field(new Embed.Field("Front/switch history", target.FrontHistoryPrivacy.Explanation())) .Description( - "To edit privacy settings, use the command:\n`pk;system privacy `\n\n- `subject` is one of `name`, `avatar`, `description`, `list`, `front`, `fronthistory`, `groups`, or `all` \n- `level` is either `public` or `private`."); + "To edit privacy settings, use the command:\n`pk;system privacy `\n\n- `subject` is one of `name`, `avatar`, `description`, `banner`, `list`, `front`, `fronthistory`, `groups`, or `all` \n- `level` is either `public` or `private`."); return ctx.Reply(embed: eb.Build()); } diff --git a/docs/content/user-guide.md b/docs/content/user-guide.md index 04488b7b..7813cf20 100644 --- a/docs/content/user-guide.md +++ b/docs/content/user-guide.md @@ -667,6 +667,7 @@ There are various reasons you may not want information about your system or your At the moment, there are a few aspects of system privacy that can be configured. - System description +- System banner - System pronouns - Member list - Group list @@ -683,6 +684,7 @@ To update your system privacy settings, use the following commands: * `subject` is one of: * `description` + * `banner` * `pronouns` * `list` * `groups` @@ -707,6 +709,7 @@ There are also some options for configuring member privacy: - Name - Description +- Banner - Avatar - Birthday - Pronouns @@ -727,6 +730,7 @@ To update a member's privacy, you can use the command: * `subject` is one of: * `name` * `description` + * `banner` * `avatar` * `birthday` * `pronouns`