Jakub Kuczys
47193b63b0
[3.4] [Modlog] Make modlogset cases docstring less vague ( #5352 ) ( #6076 )
...
Co-authored-by: OofChair <oofchairr@gmail.com >
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com >
Co-authored-by: aikaterna <20862007+aikaterna@users.noreply.github.com >
2023-04-19 22:37:12 +00:00
Jakub Kuczys
dd9cf4da6e
[3.4] [Docs] Use gender neutral language in remaining places where it isn't ( #5873 ) ( #6075 )
...
Co-authored-by: Leet <36166244+leetfin@users.noreply.github.com >
2023-04-19 22:36:05 +00:00
Jakub Kuczys
4a66c4910f
[3.4] docs: fix typos ( #5989 ) ( #6073 )
...
Co-authored-by: Lioness100 <jchickmm2@gmail.com >
Co-authored-by: Flame442 <34169552+Flame442@users.noreply.github.com >
2023-04-19 22:33:20 +00:00
Red-GitHubBot
d3363d560c
[3.4] [Docs] Dev Cog Guide ( #5869 ) ( #6058 )
...
Co-authored-by: Kreusada <67752638+Kreusada@users.noreply.github.com >
Co-authored-by: Flame442 <34169552+Flame442@users.noreply.github.com >
Co-authored-by: Jakub Kuczys <me@jacken.men >
2023-04-19 22:19:47 +00:00
Red-GitHubBot
05ca09c47c
[3.4] [CustomCom] Fix [p]cc cooldown docstring & docs ( #5914 ) ( #6064 )
...
Co-authored-by: Flame442 <34169552+Flame442@users.noreply.github.com >
2023-04-19 22:09:32 +00:00
Red-GitHubBot
ce5417602f
[3.4] Use usage attr to remove appended underscore for from_ parameter in [p]reorderpath ( #5946 ) ( #6044 )
...
Co-authored-by: Kreusada <67752638+Kreusada@users.noreply.github.com >
2023-04-19 23:01:41 +02:00
Red-GitHubBot
730c650bb4
[3.4] Fix short help in docstrings for core cogs and commands ( #5502 ) ( #5503 )
...
* fix part of command description not appearing in the help command.
* Add more
(cherry picked from commit 337f58f9fb79806064+Arman0334@users.noreply.github.com >
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com >
Co-authored-by: GhOsT <79806064+Arman0334@users.noreply.github.com >
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com >
2021-12-30 21:32:59 +00:00
jack1142
a52356c031
[3.4] [Core] Changed prefix length to 40. ( #5476 ) ( #5487 )
...
* Update core_commands.py
* Docs yes facebook's metaverse
*jokes on me*
* meta
* forgot here
* Update core_commands.py
* Forgot here
* And forgot here
(cherry picked from commit b091f13df563972751+ltzmax@users.noreply.github.com >
Co-authored-by: MAX <63972751+ltzmax@users.noreply.github.com >
2021-12-25 04:17:20 +01:00
jack1142
4afa4f77e0
[3.4] [Docs] Correct set api examples to be consistent for Spotify ( #5444 ) ( #5482 )
...
* consistant usage
* switch audiodb to youtube
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com >.
(cherry picked from commit bae85c35c1yamikaitou@gmail.com >
Co-authored-by: Ryan <yamikaitou@gmail.com >
2021-12-25 00:21:25 +00:00
Red-GitHubBot
59c92041fc
[3.4] [Admin] Add [p]selfroleset clear command ( #5387 ) ( #5409 )
...
(cherry picked from commit b64ece3ee967752638+Kreusada@users.noreply.github.com >
Co-authored-by: Kreus Amredes <67752638+Kreusada@users.noreply.github.com >
2021-10-19 12:28:10 +02:00
Red-GitHubBot
33ed1085ab
[3.4] Fix descriptions for examples of ID-based command invocations in Mod ( #5372 ) ( #5399 )
...
* Fix wording in redbot/cogs/mod/kickban.py to match with the command example
* Made changes as requested in PR Review #770078179
* Added changes to docs/cog_guides/mod.rst as requested in PR Review #70784066
* Fixed kick wording
* Fix kick wording
(cherry picked from commit 9aee8ce28f24494367+WreckRox@users.noreply.github.com >
Co-authored-by: WreckRox <24494367+WreckRox@users.noreply.github.com >
2021-10-15 23:30:44 +00:00
Red-GitHubBot
ad5a5017b6
[3.4] Add CommandConverter and CogConverter + add usage in Core ( #5037 ) ( #5299 )
...
* add commands, cog converter
* properly use type_checking
* make core commands use command converter
* update commands to use cogconverter
* fix undefined variable name, style
* Update redbot/core/commands/converter.py
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com >
* Update redbot/core/commands/converter.py
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com >
* Update redbot/core/core_commands.py
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com >
* Update redbot/core/core_commands.py
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com >
* Update redbot/core/core_commands.py
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com >
* Update redbot/core/core_commands.py
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com >
* Update redbot/core/core_commands.py
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com >
* update cog argument names
* update documentation arg names
* update more docs
* This new Sphinx is annoying about this...
* I'm questioning my skills
* Fix name error in `[p]embedset showsettings` when command is not given
* Do not use the new cog converter in `[p]command enablecog`
This is needed so that a cog that isn't loaded but was disabled
can be enabled back.
(cherry picked from commit e5b236fb1c61065078+phenom4n4n@users.noreply.github.com >
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com >
Co-authored-by: PhenoM4n4n <61065078+phenom4n4n@users.noreply.github.com >
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com >
2021-09-08 22:56:20 +02:00
Red-GitHubBot
9482f0c60c
[3.4] [Docs] Update Cleanup docs with new cleanupset command group ( #5245 ) ( #5298 )
...
* Add cleanupset commands to cleanup docs
* fix spacing
* shown -> sent
* update command docstring
* Fix trailing whitespace and use same style for docs
(cherry picked from commit 63fd7cc95f67752638+Kreusada@users.noreply.github.com >
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com >
Co-authored-by: Kreus Amredes <67752638+Kreusada@users.noreply.github.com >
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com >
2021-09-08 22:52:14 +02:00
Red-GitHubBot
373c04de11
[3.4] Add [p]diagnoseissues command ( #5243 ) ( #5294 )
...
* Split `Requires._transition_state` into reusable methods for Diagnoser
* (style) Fix line length
* Add missing .format()
* Add handling for user permissions, privilege level, Permissions rules
* Add missing awaits, use correct method in user perms check, add 'the'
* Fix .format() fields
* Add comment
* Add new file to labeler's configuration
* Add the command to the documentation
* All the work from DiagnoserCog
You can find the commit history of it here:
https://github.com/jack1142/DiagnoserCog
* Fix circular import
* Make channel argument optional
* Add a tip about channels from different servers
(cherry picked from commit 86649e897f6032823+jack1142@users.noreply.github.com >
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com >
2021-09-08 22:40:25 +02:00
Red-GitHubBot
119550739e
[3.4] [Filter] Add filter clear commands ( #4981 ) ( #5283 )
...
* [Filter] Add filter clear commands
* define messagepredicate
* actually send msg, lol
* deco fixes
* black
* [Docs] Update filter documentation
* fixes
* style
* Add missing whitespace
(cherry picked from commit f62809320867752638+Kreusada@users.noreply.github.com >
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com >
Co-authored-by: Kreus Amredes <67752638+Kreusada@users.noreply.github.com >
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com >
2021-09-08 22:11:47 +02:00
Red-GitHubBot
497cb50716
[3.4] [Admin] Allow selfroleset command to consume multiple roles ( #5238 ) ( #5278 )
...
* Initial commit
* update docs
* remove usage kwargs
* style
* Type hint with SelfRole and not discord.Role
* fix docstring
* Various improvements, fixes
* i need to wake up
* more improvements
* AAAA
* add back check
* Improve converter error
(cherry picked from commit b0f93a3ce167752638+Kreusada@users.noreply.github.com >
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com >
Co-authored-by: Kreus Amredes <67752638+Kreusada@users.noreply.github.com >
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com >
2021-09-08 21:56:41 +02:00
Red-GitHubBot
dbe50bc6fe
[3.4] [Help] Let owners set menu reaction timeout ( #5205 ) ( #5277 )
...
* initial help reaction timeout with min 15, max 300
* slight wording change
* docs!
* aaa
* Suggestions from code review, thank Jack!
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com >
(cherry picked from commit f8664a4e8avex@vexcodes.com >
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com >
Co-authored-by: Vexed <vex@vexcodes.com >
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com >
2021-09-08 21:55:03 +02:00
Red-GitHubBot
2635300b44
[3.4] [Docs] Fix argument formatting in Admin cog guide ( #5219 ) ( #5262 )
...
(cherry picked from commit ec5428f1e967752638+Kreusada@users.noreply.github.com >
Co-authored-by: Kreus Amredes <67752638+Kreusada@users.noreply.github.com >
2021-09-08 21:28:27 +02:00
Red-GitHubBot
e3e8ab784b
[3.4] [Docs] Fix warning block in Mod cog guide ( #5220 ) ( #5260 )
...
(cherry picked from commit 48fa10343c67752638+Kreusada@users.noreply.github.com >
Co-authored-by: Kreus Amredes <67752638+Kreusada@users.noreply.github.com >
2021-09-08 21:23:18 +02:00
Kreusada
8a6aa41d86
[CustomCommands/Docs] Fix argument name in [p]cc show command docstring ( #5149 )
...
* [CustomCom] Fix argument name in ``[p]cc show`` command docstring
* update docs
2021-06-18 17:48:46 -04:00
El Laggron
dafffd969f
[Core] Limit server prefix length ( #5117 )
...
* Restrict prefix length
* Update docs
2021-06-12 17:41:29 +02:00
Onii-chan
a428e42f1f
Update cogboard links ( #5124 )
...
* Update README.md
* Update guide_cog_creators.rst
* Update cog_manager_ui.rst
* Update README.md
2021-06-08 09:11:42 +00:00
Kreusada
b630e71d08
[Docs] Warnings Cog Guide ( #4920 )
...
* Initial commit
* labeler and index
* change parameter names and labeler
* fix typo
* docstrings, quotes and improved names
* merge conflict affect fixes
* remove aliases
* get from v3/develop
* update var names
* fixes
* improve grammar
* black
2021-05-28 19:06:52 +02:00
Kreusada
db86de3a7a
[Docs] Permissions Cog Guide ( #4985 )
...
* Initial commit
* index and grammar
* Add permissions tag to permissions cog reference
* remove alias by default
* remove alias
* labeler
* updates
2021-05-28 19:06:42 +02:00
Kreusada
dd40f00279
[Docs] Trivia List Creation User Guide ( #5023 )
...
* Initial commit
* commits
* a few fixes
* caps formatting
* labeler
* a few formatting changes
* grammar for clarity
* grammar fixes
2021-05-28 19:06:32 +02:00
Vexed
210c07d5a7
[Downloader] Allow removal of multiple repos ( #5082 )
...
* add multi repo support + docstring
* update docs
* Update redbot/cogs/downloader/downloader.py
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com >
* style
* Update redbot/cogs/downloader/downloader.py
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com >
2021-05-27 14:47:41 +02:00
Kreusada
23997d7a71
[Docs] Modlog Cog Guide ( #4919 )
...
* Initial commit
* Docstring changes and index
* Add modlog cog guide to labeler
2021-05-26 13:30:23 -04:00
TrustyJAID
631adc282f
[General] Fix usage in choose help ( #5015 )
...
Co-authored-by: Draper <27962761+Drapersniper@users.noreply.github.com >
2021-05-26 10:23:46 +01:00
Lifeismana
2d8dbad63b
Docstring Fix ( #5080 )
...
* Missing word
* Make a little more sense
2021-05-25 17:58:10 +02:00
jack1142
f8ecc32dbc
Fix the bug with Twitch display name being set as Twitch login ( #5066 )
2021-05-25 09:32:32 +01:00
jack1142
7459af25ba
Specify that cleanup commands remove messages from current channel ( #5070 )
2021-05-23 15:24:17 +01:00
Ryujin
a6c438e486
Update pronouns used for the bot in documentation ( #5053 )
...
* Update admin.rst
* Update admin.rst
* Update admin.rst
* Update admin.rst
* Update getting_started.rst
* Update admin.rst
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com >
2021-05-20 01:28:56 +02:00
Kreusada
439033ea28
[Core] Improve regionalformat docstrings ( #5055 )
...
* [Docs] Update regionalformat docs
* [Core] Improve regionalformat docstrings
2021-05-19 14:47:29 +00:00
Kreusada
3ff2132570
[Core] Update [p]autoimmune remove docstring
...
* Merge pull request #5038
* update docstring
* update docs correspondingly
2021-05-19 15:10:31 +01:00
Kreusada
410b2419dd
[Docs] Mod Cog Guide ( #4886 )
...
* 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
2021-05-18 17:10:30 -04:00
Kreusada
5d905a93ac
[Docs] Mutes Cog Guide ( #4875 )
...
* initial commit
* Update mutes.rst
* Add argument headers
* Change bool name for forcerole
* fixes
* Add mutes to toctree
* spacing adjustment
* Fix spacing between examples, use bullet points
* Add args header
* Add args header
* Add labeler glob
* unify style
* aaaaa wrong branch
* fix grammar and formatting errors
2021-05-18 17:06:50 -04:00
Jamie
54e5307307
[Streams] Smashcast removal. ( #5040 )
...
* Remove smashcast
* style
* remove smash from cog guides
2021-05-15 08:54:56 -08:00
Kreusada
d666c24bd4
[Docs] Reports Cog Guide ( #4882 )
...
* [Docs] Reports Cog Guide
* Add cog to toctree
* corrections for docs tox style
* Edit sig (#4881 )
* fix typo
* Add labeler glob
* unify style
* decapitalize disable
* black
2021-05-07 20:51:15 -04:00
Obi-Wan3
7f05841b96
[Downloader] Fix [p]cog uninstall examples ( #5019 )
...
* [Downloader] fix `[p]cog uninstall` examples
* [Docs] fix Downloader guide's `[p]cog uninstall` examples
2021-05-02 19:18:38 +02:00
bobloy
0eaa0f494c
[Docs] Core Cog Guide ( #4597 )
...
* Core guide initial commit
* Mydata docstrings
* Regenerated docs
* Lots more docstrings
* Add document link
* Up to load docstrings
* Black formatting
* docstring semantics
* "cog packages" for loads
* Refix line lengths
* Regenerate docs
* Remove link
* Regenerate docs with new code
* Some small docstrings
* Regenerate docs with new .. warning code
* More docstrings into the `set` command
* Bullet lists need blank lines.
* Regenerate docs
* Regenerate docs (fix bullet lists)
* set activity statuses docstrings
* Docstrings up to helpset pagecharlimit
* Regenerate docs
* Core guide initial commit
* Mydata docstrings
* Regenerated docs
* Lots more docstrings
* Add document link
* Up to load docstrings
* Black formatting
* docstring semantics
* "cog packages" for loads
* Refix line lengths
* Regenerate docs
* Remove link
* Regenerate docs with new code
* Some small docstrings
* Regenerate docs with new .. warning code
* More docstrings into the `set` command
* Bullet lists need blank lines.
* Regenerate docs
* Regenerate docs (fix bullet lists)
* set activity statuses docstrings
* Docstrings up to helpset pagecharlimit
* Regenerate docs
* Maxpages and delete delay docstrings
* spagetthi ctrl+v
* tagline and contact
* A little more contact
* Up to allowlist
* Up to command defaultdisablecog
* Regenerate docs
* Redo custominfo to not be terrible
* Up to default enabled cog
* More docs
* Up to command disabledmsg
* Disabled message stuff was missed
* Finish the rest of the docstrings
* Regenerate docs
* Longer description of the cog
* Regenerate Docs
* Fix some of the suggestions
* Apply additional suggests and some small rewording.
* Regenerate docs.
* Apply suggestions and make additional fixes
* Regenerate docs
* Clarifies it's only loaded.
* Regenerate docs.
* New formatting, more examples, some fixes
* Regenerate docs
* Adds consistant use of dashes to arguments
* More consistant punctuation
* Regenerate docs
* Add labeler detection
* Fix example and use clearing language for helpset verifyexists docstring
* Regenerate docs
* Add leave example and arguments
* Regenerate docs
* Regenerate docs
* Make embedset more readable
(933aefd3ee
2021-04-07 13:01:34 -04:00
jack1142
24fadad4cf
Remove unnecessary escape ( #4901 )
2021-03-29 14:07:53 +02:00
kreusada
8d03fef566
[Docs] Image Cog Guide ( #4821 )
...
* [Docs] Images Cog Guide
* [Docs] Image Cog Guide
* Fixes for directory inside the index
* The cog is cakked IMAGE not IMAGES
* Potential fixes for failing checks
* Grammar fixes
* Some formatting updates
* Fix merge conflicts from 3.4.7
* Re-format for requested changes
2021-03-03 14:19:33 -05:00
kreusada
92ea92b617
[Docs] General Cog Guide ( #4797 )
...
* [Docs] General Cog Guide
* Doc Style Fixes
* Requested Changes
* Additional grammar fix that was missed
Co-authored-by: kreusada <67752638+kreus7@users.noreply.github.com >
2021-02-22 13:56:43 -05:00
palmtree5
b20fc9f6af
[Docs] Trivia user guide ( #4566 )
...
* Start on Trivia user guide
* Finish command coverage + add to toctree
* wip note on list creation section
* Apply suggestions from code review
Co-authored-by: bobloy <alboblexloy@gmail.com >
* Update docs/cog_guides/trivia.rst
Co-authored-by: bobloy <alboblexloy@gmail.com >
* Drop list creation guide for now + fix formatting
* Apply suggestions from code review
Co-authored-by: Flame442 <34169552+Flame442@users.noreply.github.com >
* permissions notes
Co-authored-by: bobloy <alboblexloy@gmail.com >
Co-authored-by: Flame442 <34169552+Flame442@users.noreply.github.com >
2021-02-20 14:38:18 -05:00
Wyn
bee022d1bb
Make [p]selfrole without subcommand "toggle" the selfrole ( #4826 )
...
* Merge selfrole and remove into one command
replacement pr
* docs
add to the docs
* Update admin.py
remove register name
* Update admin.rst
* Fixes
* Fix the duplicated command decorators
* Minimize the diff
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com >
2021-02-16 15:16:16 +01:00
Andy
5b670c074f
Update [p]economyset slottime&paydaytime to use TimedeltaConverter and not accept negative integers ( #4807 )
...
* add a time converter, as well as not allowing negative integers
* timedeltaconverter
* styling and unused imports
* update docstrings
* update param name to "duration" instead of seconds
* make timedelta default_unit seconds
* better descriptions & docstrings
* docs for updated paydaytime & slottime
* Fix style
* Few minor fixes
* Cast `total_seconds()` return type to `int`
* Fix one of my own issues
* Make the duration argument catch-rest for convenience
* One more fix for the docs
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com >
2021-02-15 22:25:03 +01:00
Danstr5544
d6de9c1b94
Add a way to reset rolepayday amounts ( #4758 )
...
* Add a way to reset rolepayday amounts
* Totally not fixing a typo...
* Jack found a Typo
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com >
* Max line length Compliancy
Thanks Jack (again lol)
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com >
* Including rolepaydayamount changes in docs
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com >
2021-01-29 21:50:22 +01:00
bobloy
8d512e206a
[Docs] Filter Cog Guide ( #4579 )
...
* Add filter to index
* Initial generated docs
* Start on docstrings
* More docstrings
* Some more docstrings
* Rest of the doc strings
* Regenerate docs
* Remove unnecessary language. Move to one line.
* Regenerate docs
* Update redbot/cogs/filter/filter.py
Co-authored-by: Flame442 <34169552+Flame442@users.noreply.github.com >
* Update redbot/cogs/filter/filter.py
Co-authored-by: Flame442 <34169552+Flame442@users.noreply.github.com >
* Update redbot/cogs/filter/filter.py
Co-authored-by: Flame442 <34169552+Flame442@users.noreply.github.com >
* Update docs/cog_guides/filter.rst
Co-authored-by: Flame442 <34169552+Flame442@users.noreply.github.com >
* Update docs/cog_guides/filter.rst
Co-authored-by: Flame442 <34169552+Flame442@users.noreply.github.com >
* Update docs/cog_guides/filter.rst
Co-authored-by: Flame442 <34169552+Flame442@users.noreply.github.com >
Co-authored-by: Flame442 <34169552+Flame442@users.noreply.github.com >
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com >
2021-01-16 02:10:45 +00:00
jack1142
b36a702e62
Make command usage in help for required arguments consistent ( #4589 )
...
* Make command usage in help for required arguments consistent
* Bob 3
* Bob 1
* Docstring updates
* Address Flame's review
* Update cog guides in docs
2020-12-22 14:14:47 -05:00
palmtree5
04cb1befe6
[Docs] Streams user guide ( #4521 )
...
* Start on streams user guide
* Finish up streams guide
* Fix a typo in the doc page
* Fix the SAME typo in the relevant command's docstring while we're here
Co-authored-by: palmtree5 <palmtree5+3577255@users.noreply.github.com >
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com >
2020-11-27 13:52:56 -05:00
