Red-DiscordBot
Red-DiscordBot copied to clipboard
[Modlog] Make `modlogset cases` docstring less vague
Description of the changes
Mentioned in Red so thought it would be an easy fix :P
What I was thinking when I mentioned this was that the argument of "action" in the function signature was vague, and that it didn't lend very many hints to the user to what "action" does or what they need to do. So my idea of this improvement was:
Syntax: [p]modlogset cases [action]
Enable or disable case creation for a mod action.
An action can be enabling or disabling specific cases.
Example: [p]modlogset cases kick enabled
Or something similar to this that explains it better.
I updated the docstring, and I added in examples of what you can enable/disable. Should be good for review :)
It may be worth adding the same examples of what actions are to the documentation at
docs/cog_guides/modlog.rst
.
Good idea, I just added that ☺
I resolved the conflicts so this can be reviewed again.
Hi Oof, your docstring is still vague to me. Please refer to my earlier comment about a command example in the docstring.
Thanks, the example added to the docstring was what I was looking for. Can you do the same to the docs too please, since in the docs there are examples of command usage for other various core commands?
Please make the formatting on the docs' subtitle headers similar to the existing ones.
An existing example ("Examples" and "Arguments" are bolded and italicised):
Your current implementation:
Sorry, @Jackenmen, I could not cleanly backport this to 3.4
due to a conflict. Please backport using cherry_picker on command line.
cherry_picker 6cda937ec232bca570999d28dc40b9e0ee88f7fe 3.4
#6076 is a backport of this pull request to Red 3.4.