Doc tweaks

cogs/patterncog.py

@@ -136,10 +136,10 @@ class PatternCog(BaseCog):
 	# 	return patterns
 
 	def __get_patterns(self, guild: Guild) -> dict:
-		patterns = Storage.get_state_value(guild, 'PatternsCog.patterns')
+		patterns = Storage.get_state_value(guild, 'PatternCog.patterns')
 		if patterns is None:
 			patterns = {}
-			patterns_encoded = Storage.get_config_value(guild, 'PatternsCog.patterns')
+			patterns_encoded = Storage.get_config_value(guild, 'PatternCog.patterns')
 			if patterns_encoded:
 				for pe in patterns_encoded:
 					name = pe.get('name')
@@ -149,7 +149,7 @@ class PatternCog(BaseCog):
 						patterns[name] = ps
 					except RuntimeError as e:
 						self.log(guild, f'Error parsing saved statement "{name}". Skipping: {statement}')
-			Storage.set_state_value(guild, 'PatternsCog.patterns', patterns)
+			Storage.set_state_value(guild, 'PatternCog.patterns', patterns)
 		return patterns
 
 	def __save_patterns(self, guild: Guild, patterns: dict) -> None:
@@ -159,7 +159,7 @@ class PatternCog(BaseCog):
 				'name': name,
 				'statement': statement.original,
 			})
-		Storage.set_config_value(guild, 'PatternsCog.patterns', to_save)
+		Storage.set_config_value(guild, 'PatternCog.patterns', to_save)
 
 	@commands.Cog.listener()
 	async def on_message(self, message: Message) -> None:
@@ -258,14 +258,16 @@ class PatternCog(BaseCog):
 	)
 	@commands.has_permissions(ban_members=True)
 	@commands.guild_only()
-	async def patterns(self, context: commands.Context):
+	async def pattern(self, context: commands.Context):
 		'Message pattern matching'
 		if context.invoked_subcommand is None:
 			await context.send_help()
 
-	@patterns.command(
+	@pattern.command(
 		brief='Adds a custom pattern',
-		description='Adds a custom pattern. Patterns use a simplified expression language. Full documentation found here: https://git.rixafrix.com/ialbert/python-app-rocketbot/src/branch/master/patterns.md',
+		description='Adds a custom pattern. Patterns use a simplified ' + \
+			'expression language. Full documentation found here: ' + \
+			'https://git.rixafrix.com/ialbert/python-app-rocketbot/src/branch/master/patterns.md',
 		usage='<pattern_name> <expression...>',
 		ignore_extra=True
 	)
@@ -284,7 +286,7 @@ class PatternCog(BaseCog):
 				f'{CONFIG["failure_emoji"]} Error parsing statement. {e}',
 				mention_author=False)
 
-	@patterns.command(
+	@pattern.command(
 		brief='Removes a custom pattern',
 		usage='<pattern_name>'
 	)
@@ -301,7 +303,7 @@ class PatternCog(BaseCog):
 				f'{CONFIG["failure_emoji"]} No pattern named `{name}`.',
 				mention_author=False)
 
-	@patterns.command(
+	@pattern.command(
 		brief='Lists all patterns'
 	)
 	async def list(self, context: commands.Context) -> None:

patterns.md

@@ -2,18 +2,32 @@
 
 The PatternCog offers a way of creating custom message filters of moderate complexity without needing to make code changes in the bot and redeploy it. A guild can have any number of custom patterns. The commands are:
 
-`$rb_patterns add <name> <statement>` - Add a new named pattern
-`$rb_patterns remove <name>` - Remove a named pattern
-`$rb_patterns list` - List all named patterns
+* `$rb_pattern add <name> <statement>` - Add a new named pattern
+* `$rb_pattern remove <name>` - Remove a named pattern
+* `$rb_pattern list` - List all named patterns
 
 The pattern `<name>` can be anything. If it contains spaces, enclose it in double quotes, e.g. `"my filter"`.
 
 ## Statements
 
-A statement consists of one or more actions to take on a message followed by an expression defining the criteria for which messages match.
+A statement consists of one or more actions to take on a message followed by an expression defining the criteria for which messages match. For example:
+
+```
+reply "You can't say that word!", delete if message contains "heck"
+```
+
+This statement has two actions: replying, then deleting the original message. It will match any word that contains the word "heck".
+
+The list of actions and the matching expression are separated by the word "if", which must be present in every statement.
 
 ### Actions
 
+One or more actions can be added to the statement. If there is more than one, they are separated with commas. Example:
+
+```
+delete, kick, modwarn
+```
+
 Available actions:
 
 * `ban` - Bans the user. The "reason" in the audit log will reference the pattern name.
@@ -91,6 +105,28 @@ Lastly, expressions can be inverted by prefixing a `!`. For example:
 
 This will only match messages that do not contain both "me" and "you". If it contains just "me" or just "you" or neither word then it will match. If both are present it will not match.
 
+## Examples
+
+Here are examples of `add` commands:
+
+Automatically delete a banned word:
+
+```
+$rb_pattern add "bad word" delete if content contains "darn"
+```
+
+Ban anyone who posts a URL within the first 30 minutes of joining the server.
+
+```
+$rb_pattern add "url spam" ban if author.joinage < 30m and (content contains "http://" or content contains "https://")
+```
+
+Automatically reply to anyone asking when lunch is.
+
+```
+$rb_pattern add "lunch" reply "Lunch is at noon." if content == "When is lunch?"
+```
+
 ## Grammar
 
 `<statement>` ::= `<actions>` " if " `<expression>`