Red-DiscordBot icon indicating copy to clipboard operation
Red-DiscordBot copied to clipboard

[Modlog] Make `modlogset cases` docstring less vague

Open OofChair opened this issue 3 years ago • 7 comments

Description of the changes

Mentioned in Red so thought it would be an easy fix :P

OofChair avatar Oct 01 '21 00:10 OofChair

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.

aikaterna avatar Oct 01 '21 15:10 aikaterna

I updated the docstring, and I added in examples of what you can enable/disable. Should be good for review :)

OofChair avatar Oct 03 '21 23:10 OofChair

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 ☺

OofChair avatar Oct 12 '21 23:10 OofChair

I resolved the conflicts so this can be reviewed again.

Jackenmen avatar Dec 23 '21 17:12 Jackenmen

Hi Oof, your docstring is still vague to me. Please refer to my earlier comment about a command example in the docstring.

aikaterna avatar Feb 07 '22 19:02 aikaterna

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?

aikaterna avatar Feb 13 '22 03:02 aikaterna

Please make the formatting on the docs' subtitle headers similar to the existing ones.

An existing example ("Examples" and "Arguments" are bolded and italicised): Screen Shot 2022-02-24 at 6 18 36 PM

Your current implementation: Screen Shot 2022-02-24 at 6 18 48 PM

aikaterna avatar Feb 25 '22 02:02 aikaterna

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

red-githubbot[bot] avatar Apr 19 '23 21:04 red-githubbot[bot]

#6076 is a backport of this pull request to Red 3.4.

red-githubbot[bot] avatar Apr 19 '23 22:04 red-githubbot[bot]