CopyBot/Red-DiscordBot
1
0
Fork 0
mirror of https://github.com/Cog-Creators/Red-DiscordBot.git synced 2025-12-08 18:32:32 -05:00
Code Issues Packages Projects Releases Wiki Activity

[Docs] Mod Cog Guide (#4886)

Browse Source 
* Initial commit

* Add some args

* bool prolog

* index

* Add more arguments

* more arguments, style fixes

* improve naming of arguments

* Fix up backlog

* Run black

* extra corrections from backlog

* Update tempban arg names

* backlog

* change prolog type

* Change kick argument prolog to member instead of user

* Update argument names

* missed a colon

* Update prolog to be friendly with non-positional args

* Edit through the decorator instead

* Add back docstring spacing

* black

* usage in decorator for name commands

* Fix command signature

* fixup docstring spacing

* style fixes

* Add spacing inside unban docstring

* Rename args instead of using usage

* black - simple

* Add labeler glob

* unify style

* rename variables instead of usage

* Update docstrings correspondingly

* run black

* update description in usage

* ehh this isn't necessary...

* fix up tags

* fix grammar and accuracy issues

* fix docstring too
This commit is contained in:
Kreusada
2021-05-18 22:10:30 +01:00
committed by GitHub
parent 5d905a93ac
commit 410b2419dd
6 changed files with 857 additions and 82 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/prolog.txt
View File

@@ -27,16 +27,16 @@
.. |role-input-quotes| replace:: Please give **the exact role name or ID**, or it won't be detected.
If the role name has spaces, provide it enclosed in quotes like this: ``"my role with spaces"``
.. |member-input| replace:: You can either mention the member, provide its ID, its exact name with
the tag or not, or its nickname.
.. |member-input| replace:: You can either mention the member, provide their ID, their exact name with
the tag or not, or their nickname.
.. |member-input-quotes| replace:: You can either mention the member, provide its ID, its exact
name with the tag or not, or its nickname enclosed in quotes if there are spaces.
.. |member-input-quotes| replace:: You can either mention the member, provide their ID, their exact
name with the tag or not, or their nickname enclosed in quotes if there are spaces.
.. |user-input| replace:: You can either provide the member's ID or its exact name with the tag or
.. |user-input| replace:: You can either provide the member's ID or their exact name with the tag or
not.
.. |user-input-quotes| replace:: You can either provide the member's ID or its exact name with the
.. |user-input-quotes| replace:: You can either provide the member's ID or their exact name with the
tag or not, enclosed in quotes if there are spaces.
.. |channel-input| replace:: You can either mention the channel, provide its exact name or its ID.
@@ -48,3 +48,7 @@
.. |color-input| replace:: You can either provide the hexadecimal code of the color, or one of the
colors listed here: :class:`discord.Color`.
.. These are the comments for parameter types such as `bool`.
.. |bool-input| replace:: You should provide either 'true' or 'false'.