Config help on protected keys

Author: Taaku18

CHANGELOG.md

@@ -12,6 +12,7 @@ however, insignificant breaking changes does not guarantee a major version bump,
 
 - `disable_recipient_thread_close` is removed, a new configuration variable `recipient_thread_close` replaces it which defaults to False.
 - Truthy and falsy values for binary configuration variables are now interpreted respectfully.
+- `LOG_URL_PREFIX` cannot be set to "NONE" to specify no additional path in the future, "/" is the new method.
 
 ### Added
 

cogs/modmail.py

@@ -572,9 +572,9 @@ def format_log_embeds(self, logs, avatar_url):
         for entry in logs:
             created_at = parser.parse(entry["created_at"])
 
-            prefix = self.bot.config['log_url_prefix'].strip('/')
-            if prefix == 'NONE':
-                prefix = ''
+            prefix = self.bot.config["log_url_prefix"].strip("/")
+            if prefix == "NONE":
+                prefix = ""
             log_url = f"{self.bot.config['log_url'].strip('/')}{'/' + prefix if prefix else ''}/{entry['key']}"
 
             username = entry["recipient"]["name"] + "#"

cogs/utility.py

@@ -844,8 +844,9 @@ async def config_get(self, ctx, key: str.lower = None):
                     color=Color.red(),
                     description=f"`{key}` is an invalid key.",
                 )
-                valid_keys = [f"`{k}`" for k in keys]
-                embed.add_field(name="Valid keys", value=", ".join(valid_keys))
+                embed.set_footer(
+                    text=f'Type "{self.bot.prefix}config options" for a list of config variables.'
+                )
 
         else:
             embed = Embed(
@@ -870,7 +871,9 @@ async def config_help(self, ctx, key: str.lower):
         """
         Show information on a specified configuration.
         """
-        if key not in self.bot.config.public_keys:
+        if not (
+            key in self.bot.config.public_keys or key in self.bot.config.protected_keys
+        ):
             embed = Embed(
                 title="Error",
                 color=Color.red(),
@@ -904,10 +907,11 @@ def fmt(val):
             embed.add_field(
                 name="Information:", value=fmt(info["description"]), inline=False
             )
-            example_text = ""
-            for example in info["examples"]:
-                example_text += f"- {fmt(example)}\n"
-            embed.add_field(name="Example(s):", value=example_text, inline=False)
+            if info["examples"]:
+                example_text = ""
+                for example in info["examples"]:
+                    example_text += f"- {fmt(example)}\n"
+                embed.add_field(name="Example(s):", value=example_text, inline=False)
 
             note_text = ""
             for note in info["notes"]:

core/config_help.json

@@ -373,5 +373,77 @@
       "See also: `anon_avatar_url`, `anon_username`, `mod_tag`."
     ],
     "image": "https://i.imgur.com/SKOC42Z.png"
+  },
+  "modmail_guild_id": {
+    "default": "Fallback on `GUILD_ID`",
+    "description": "The ID of the discord server where the threads channels should be created (receiving server).",
+    "examples": [
+    ],
+    "notes": [
+      "This configuration can only to be set through `.env` file or environment (config) variables."
+    ]
+  },
+  "guild_id": {
+    "default": "None, required",
+    "description": "The ID of the discord server where recipient users reside (users server).",
+    "examples": [
+    ],
+    "notes": [
+      "This configuration can only to be set through `.env` file or environment (config) variables."
+    ]
+  },
+  "log_url": {
+    "default": "https://example.com/",
+    "description": "The base log viewer URL link, leave this as-is to not configure a log viewer.",
+    "examples": [
+    ],
+    "notes": [
+      "This configuration can only to be set through `.env` file or environment (config) variables."
+    ]
+  },
+  "log_url_prefix": {
+    "default": "`/logs`",
+    "description": "The path to your log viewer extending from your `LOG_URL`, set this to `/` to specify no extra path to the log viewer.",
+    "examples": [
+    ],
+    "notes": [
+      "This configuration can only to be set through `.env` file or environment (config) variables."
+    ]
+  },
+  "mongo_uri": {
+    "default": "None, required",
+    "description": "A MongoDB SRV connection string.",
+    "examples": [
+    ],
+    "notes": [
+      "This configuration can only to be set through `.env` file or environment (config) variables."
+    ]
+  },
+  "owners": {
+    "default": "None, required",
+    "description": "A list of definite bot owners, use `{prefix}perms add level OWNER @user` to set flexible bot owners.",
+    "examples": [
+    ],
+    "notes": [
+      "This configuration can only to be set through `.env` file, ~~`config.json` file~~ (removed), or environment (config) variables."
+    ]
+  },
+  "token": {
+    "default": "None, required",
+    "description": "Your bot token as found in the Discord Developer Portal.",
+    "examples": [
+    ],
+    "notes": [
+      "This configuration can only to be set through `.env` file, ~~`config.json` file~~ (removed), or environment (config) variables."
+    ]
+  },
+  "log_level": {
+    "default": "INFO",
+    "description": "The logging level for logging to stdout.",
+    "examples": [
+    ],
+    "notes": [
+      "This configuration can only to be set through `.env` file, ~~`config.json` file~~ (removed), or environment (config) variables."
+    ]
   }
 }