diff --git a/.gitignore b/.gitignore index 1949eb809..4c9d1f86d 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,4 @@ __pycache__/ .venv/ venv/ docgen.py +_build/ diff --git a/.readthedocs.yml b/.readthedocs.yml index 572d87c28..58451b322 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -1,9 +1,12 @@ version: 2 +build: + image: "latest" + sphinx: configuration: docs/conf.py python: - version: 3.8 + version: "3.9" install: - requirements: docs/requirements.txt diff --git a/README.es.rst b/README.es.rst deleted file mode 100644 index 421692b3f..000000000 --- a/README.es.rst +++ /dev/null @@ -1,56 +0,0 @@ -.. image:: /.github/resources/kreusadacogs-artwork.png - -======================================================= -Cogs de Redbot para Red-DiscordBot creados por Kreusada -======================================================= - -Hola, estos son los cogs que construí para Red-DiscordBot. - ------------ -Instalación ------------ - -En primer lugar, asegúrese de tener cargado `downloader`. - -.. code-block:: ini - - [p]load downloader - -A continuación, agreguemos mi repositorio a su sistema. - -.. code-block:: ini - - [p]repo add kreusada https://github.com/Kreusada/Kreusada-Cogs - -Para instalar un cog, use este comando, reemplazando con el nombre del cog que desea instalar: - -.. code-block:: ini - - [p]cog install kreusada - ------------------------- -Lista de cog disponibles ------------------------- - -Consulte `aquí `_ para ver la lista de -cogs disponibles. Los cogs se agregan y eliminan sin notarlo. - -------------------- -Apoyando mi trabajo -------------------- - -Estoy aceptando donaciones a mi `patreon `_, estoy muy agradecido por cualquier cosa! - -------------- -Contribuyendo -------------- - -Si es un PR pequeño, hazlo. De lo contrario, a menos que te hayan dado luz verde, no quiero grandes -Relaciones públicas por el momento: no tengo suficiente tiempo para revisarlas. - ------ -Apoyo ------ - -Consulte mis documentos `aquí `_. -Mencióname en #support_kreusada-cogs en `cog support server `_ si necesitas ayuda. diff --git a/README.md b/README.md new file mode 100644 index 000000000..baa31de11 --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +![Kreusada Cogs Artwork](.github/resources/kreusadacogs-artwork.png) + +# Cogs for Red-DiscordBot authored by Kreusada + +Hello, these are the third party cogs I created for Red-DiscordBot. + +## Installation + +Primarily, make sure you have `downloader` loaded. + +``` +[p]load downloader +``` + +Next, let's add my repository to your system. + +``` +[p]repo add kreusada https://github.com/Kreusada/Kreusada-Cogs +``` + +To install a cog, use this command, replacing `` with the name of the cog you wish to install: + +``` +[p]cog install kreusada +``` + +## Available Cogs List + +Please see [here](https://github.com/Kreusada/Kreusada-Cogs/blob/master/cogs.csv) for the list of available cogs. Cogs get added and removed without notice. + +## Supporting My Work + +If you appreciate my work or would like to donate, I use [Ko-Fi](https://ko-fi.com/kreusada)! + +## Support + +Check out my docs [here](https://kreusadacogs.readthedocs.io/en/latest/). +Mention me in the `#support_kreusada-cogs` channel in the [cog support server](https://discord.gg/GET4DVk) if you need any help. +You can also join my [personal server](https://discord.gg/JmCFyq7) if you wish! diff --git a/README.rst b/README.rst deleted file mode 100644 index 438145fc3..000000000 --- a/README.rst +++ /dev/null @@ -1,57 +0,0 @@ -.. image:: /.github/resources/kreusadacogs-artwork.png - -=================================================== -Redbot cogs for Red-DiscordBot authored by Kreusada -=================================================== - -Hello, these are the cogs I built for Red-DiscordBot. - - ------------- -Installation ------------- - -Primarily, make sure you have `downloader` loaded. - -.. code-block:: ini - - [p]load downloader - -Next, let's add my repository to your system. - -.. code-block:: ini - - [p]repo add kreusada https://github.com/Kreusada/Kreusada-Cogs - -To install a cog, use this command, replacing with the name of the cog you wish to install: - -.. code-block:: ini - - [p]cog install kreusada - -------------------- -Available cogs list -------------------- - -Please see `here `_ for the list of -available cogs. Cogs get added and removed without noticed. - ------------------- -Supporting my work ------------------- - -I'm accepting donations to my `patreon `_, I'm very grateful for anything! - ------------- -Contributing ------------- - -If its a small PR, go for it. Otherwise, unless you've been given the green light, I don't want any big -PRs for the time being: I don't have enough sufficient time to review them. - -------- -Support -------- - -Check out my docs `here `_. -Mention me in the #support_kreusada-cogs in the `cog support server `_ if you need any help. diff --git a/cocktail/cocktail.py b/cocktail/cocktail.py index 8f46e5d7f..2c72366be 100644 --- a/cocktail/cocktail.py +++ b/cocktail/cocktail.py @@ -52,23 +52,25 @@ async def callback(self, interaction: discord.Interaction): await interaction.response.send_message(message, ephemeral=True) await self.view.message.edit(view=self.view, embed=embed) - async def on_timeout(self): - self.disabled = True - await self.view.message.edit(view=self.view) - class CocktailView(discord.ui.View): - def __init__(self, *, cog: Cocktail, cocktail: str, favourite: bool): + def __init__(self, ctx: commands.Context, cocktail: str, favourite: bool): super().__init__() self.message: discord.Message + self.ctx = ctx self.add_item( - CocktailFavouriteButton(cog=cog, cocktail=cocktail, favourite=favourite) + CocktailFavouriteButton(cog=ctx.cog, cocktail=cocktail, favourite=favourite) ) - async def interaction_check(self, interaction: discord.Interaction): - if interaction.user.id != self.message.author.id: - await interaction.response.send_message("Invoke the command yourself to add it to your favourites.", ephemeral=True) + async def on_timeout(self): + for children in self.children: + children.disabled = True + await self.message.edit(view=self.view) + async def interaction_check(self, interaction: discord.Interaction): + if self.ctx.author.id != interaction.user.id: + return interaction.response.send_message("Invoke the command yourself to add/remove from favourites!", ephemeral=True) + return True class Cocktail(commands.Cog): """Get information about different cocktails and their ingredients.""" @@ -79,7 +81,7 @@ def __init__(self, bot: Red): self.config.register_user(favourites=[]) __author__ = "Kreusada" - __version__ = "1.0.2" + __version__ = "1.1.0" def format_help_for_context(self, ctx: commands.Context) -> str: context = super().format_help_for_context(ctx) @@ -144,7 +146,7 @@ async def cocktail(self, ctx: commands.Context, *, name: str): name="Ingredients", value="\n".join(f"- {x}" for x in ingredients) ) - view = CocktailView(cog=self, cocktail=drink["strDrink"], favourite=favourite) + view = CocktailView(ctx, cocktail=drink["strDrink"], favourite=favourite) view.message = await ctx.send(embed=embed, view=view) @cocktail.command() diff --git a/cogpaths/cogpaths.py b/cogpaths/cogpaths.py index ef403de0c..50189f4a6 100644 --- a/cogpaths/cogpaths.py +++ b/cogpaths/cogpaths.py @@ -13,7 +13,7 @@ class CogPaths(commands.Cog): """Get information about a cog's paths.""" __author__ = "Kreusada" - __version__ = "1.1.0" + __version__ = "1.2.0" def __init__(self, bot: Red): self.bot = bot @@ -34,7 +34,7 @@ async def cogpath(self, ctx: commands.Context, cog: CogConverter): if not os.path.exists(cog_data_path): cog_data_path = None if not isinstance(getattr(cog, "config", None), Config): - reason = "This cog does not store any data, or does not use Red's Config API." + reason = "This cog does not store any data, does not use the `.config` attribute, or does not use Red's Config API." else: reason = "This cog had its data directory removed." message = "Cog path: {}\nData path: {}".format(cog_path, cog_data_path or reason) diff --git a/colour/colour.py b/colour/colour.py index a16b79e04..b7c6c1b1e 100644 --- a/colour/colour.py +++ b/colour/colour.py @@ -61,7 +61,7 @@ async def colour(self, ctx: commands.Context, colour: HexCodeConverter): """ async with aiohttp.ClientSession() as session: async with session.get( - f"https://www.thecolorapi.com/id?hex={str(colour)[1:]}" + f"https://www.thecolorapi.com/id?hex={str(colour)[1:]}", ssl=False ) as request: data = await request.json() if data["name"]["exact_match_name"]: diff --git a/docs/_static/black_doc_example.py b/docs/_static/black_doc_example.py new file mode 100644 index 000000000..4b1c9d2ed --- /dev/null +++ b/docs/_static/black_doc_example.py @@ -0,0 +1,4 @@ +def func(): print ("Hello world!") + +def func_2(): + if(True): print("Hello"+ "World" , "!", sep = '') diff --git a/docs/_static/examples/blackformatter/black0.png b/docs/_static/examples/blackformatter/black0.png new file mode 100644 index 000000000..5f43478e2 Binary files /dev/null and b/docs/_static/examples/blackformatter/black0.png differ diff --git a/docs/_static/examples/blackformatter/black1.png b/docs/_static/examples/blackformatter/black1.png new file mode 100644 index 000000000..f078ea48d Binary files /dev/null and b/docs/_static/examples/blackformatter/black1.png differ diff --git a/docs/_static/examples/cocktail/cocktail0.png b/docs/_static/examples/cocktail/cocktail0.png new file mode 100644 index 000000000..c05f8541e Binary files /dev/null and b/docs/_static/examples/cocktail/cocktail0.png differ diff --git a/docs/_static/examples/cocktail/cocktail1.png b/docs/_static/examples/cocktail/cocktail1.png new file mode 100644 index 000000000..57472fa94 Binary files /dev/null and b/docs/_static/examples/cocktail/cocktail1.png differ diff --git a/docs/_static/examples/cocktail/cocktail_favourites0.png b/docs/_static/examples/cocktail/cocktail_favourites0.png new file mode 100644 index 000000000..36c16a7c0 Binary files /dev/null and b/docs/_static/examples/cocktail/cocktail_favourites0.png differ diff --git a/docs/_static/examples/cocktail/cocktail_ingredient0.png b/docs/_static/examples/cocktail/cocktail_ingredient0.png new file mode 100644 index 000000000..1d877dfeb Binary files /dev/null and b/docs/_static/examples/cocktail/cocktail_ingredient0.png differ diff --git a/docs/_static/examples/cogpaths/cogpath0.png b/docs/_static/examples/cogpaths/cogpath0.png new file mode 100644 index 000000000..d332ef493 Binary files /dev/null and b/docs/_static/examples/cogpaths/cogpath0.png differ diff --git a/docs/_static/examples/colour/colour0.png b/docs/_static/examples/colour/colour0.png new file mode 100644 index 000000000..3784c31e7 Binary files /dev/null and b/docs/_static/examples/colour/colour0.png differ diff --git a/docs/_static/examples/consoleclearer/clearconsole0.png b/docs/_static/examples/consoleclearer/clearconsole0.png new file mode 100644 index 000000000..59a4d357f Binary files /dev/null and b/docs/_static/examples/consoleclearer/clearconsole0.png differ diff --git a/docs/_static/examples/consoleclearer/clearconsole1.png b/docs/_static/examples/consoleclearer/clearconsole1.png new file mode 100644 index 000000000..9c3f03e2e Binary files /dev/null and b/docs/_static/examples/consoleclearer/clearconsole1.png differ diff --git a/docs/_static/examples/embedcreator/embedcreate0.png b/docs/_static/examples/embedcreator/embedcreate0.png new file mode 100644 index 000000000..2f8ae9d6f Binary files /dev/null and b/docs/_static/examples/embedcreator/embedcreate0.png differ diff --git a/docs/_static/examples/flags/flag0.png b/docs/_static/examples/flags/flag0.png new file mode 100644 index 000000000..4535ed18f Binary files /dev/null and b/docs/_static/examples/flags/flag0.png differ diff --git a/docs/_static/examples/flags/flag1.png b/docs/_static/examples/flags/flag1.png new file mode 100644 index 000000000..802862a28 Binary files /dev/null and b/docs/_static/examples/flags/flag1.png differ diff --git a/docs/_templates/relations.html b/docs/_templates/relations.html deleted file mode 100644 index 9eab08ad7..000000000 --- a/docs/_templates/relations.html +++ /dev/null @@ -1 +0,0 @@ - diff --git a/docs/cog_riddles.rst b/docs/cog_riddles.rst index 1c19a6f8d..459f3aa5b 100644 --- a/docs/cog_riddles.rst +++ b/docs/cog_riddles.rst @@ -32,8 +32,9 @@ Commands Here are all the commands included in this cog (1): -* ``[p]riddle`` - Get a random riddle. +Command Help +------------- -------------------- +``[p]riddle`` Get a random riddle. ------------ Installation diff --git a/docs/cog_texteditor.rst b/docs/cog_texteditor.rst index 7a583690c..cc83b7ffa 100644 --- a/docs/cog_texteditor.rst +++ b/docs/cog_texteditor.rst @@ -32,58 +32,61 @@ Commands Here are all the commands included in this cog (25): -* ``[p]editor`` - Base command for editing text. -* ``[p]editor alternating `` - Convert the text to alternating case. -* ``[p]editor bullet [items...]`` - Bullet point a selection of items. -* ``[p]editor charcount `` - Count the number of characters appearing in the text. -* ``[p]editor formatnumber `` - Format a number with commas. -* ``[p]editor levenshtein `` - Calculate the Levenshtein distance between two words. -* ``[p]editor lower `` - Convert the text to lowercase. -* ``[p]editor multiply `` - Multiply the text. -* ``[p]editor occurance `` - Count how many times something appears in the text. -* ``[p]editor palindrome `` - Checks for any palindromes within the text. -* ``[p]editor permutate `` - Generate permutations for given combinations of words/digits. -* ``[p]editor remove `` - Remove something from the text. -* ``[p]editor replace `` - Replace certain parts of the text. -* ``[p]editor reverse `` - Reverse the text. -* ``[p]editor shlex `` - Shlex split a given string. -* ``[p]editor shuffle `` - Shuffle the word order in the text. -* ``[p]editor snake `` - Convert all spaces to underscores. -* ``[p]editor squash `` - Squash all the words into one. -* ``[p]editor swapcase `` - Swap the casing for text. -* ``[p]editor title `` - Convert the text to titlecase. -* ``[p]editor trim [trimmer= ] `` - Trim the outskirts of the text. -* ``[p]editor typoglycemia `` - Scrambles all letters except the first and last letters in a word. - - Aoccdrnig to a rscheearch at Cmabrigde Uinervtisy, it deosn't mttaer in waht oredr the ltteers in a wrod are, the olny iprmoetnt tihng is taht the frist and lsat ltteer be at the rghit pclae. The rset can be a toatl mses and you can sitll raed it wouthit porbelm. Tihs is bcuseae the huamn mnid deos not raed ervey lteter by istlef, but the wrod as a wlohe. -* ``[p]editor upper `` - Convert the text to uppercase. -* ``[p]editor wordcount `` - Count the number of words appearing in the text. -* ``[p]editor wrap [cut_words=True] `` - Wrap the text. ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Command | Help | ++============================+=======================================================================================================================================================================================================================================================================================================================================================================+ +| ``[p]editor`` | Base command for editing text. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor alternating`` | Convert the text to alternating case. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor bullet`` | Bullet point a selection of items. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor charcount`` | Count the number of characters appearing in the text. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor formatnumber`` | Format a number with commas. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor levenshtein`` | Calculate the Levenshtein distance between two words. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor lower`` | Convert the text to lowercase. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor multiply`` | Multiply the text. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor occurance`` | Count how many times something appears in the text. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor palindrome`` | Checks for any palindromes within the text. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor permutate`` | Generate permutations for given combinations of words/digits. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor remove`` | Remove something from the text. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor replace`` | Replace certain parts of the text. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor reverse`` | Reverse the text. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor shlex`` | Shlex split a given string. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor shuffle`` | Shuffle the word order in the text. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor snake`` | Convert all spaces to underscores. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor squash`` | Squash all the words into one. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor swapcase`` | Swap the casing for text. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor title`` | Convert the text to titlecase. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor trim`` | Trim the outskirts of the text. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor typoglycemia`` | Scrambles all letters except the first and last letters in a word. | +| | | +| | Aoccdrnig to a rscheearch at Cmabrigde Uinervtisy, it deosn't mttaer in waht oredr the ltteers in a wrod are, the olny iprmoetnt tihng is taht the frist and lsat ltteer be at the rghit pclae. The rset can be a toatl mses and you can sitll raed it wouthit porbelm. Tihs is bcuseae the huamn mnid deos not raed ervey lteter by istlef, but the wrod as a wlohe. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor upper`` | Convert the text to uppercase. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor wordcount`` | Count the number of words appearing in the text. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor wrap`` | Wrap the text. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ------------ Installation diff --git a/docs/conf.py b/docs/conf.py index 6901e7624..97022c318 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,6 +1,5 @@ exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".venv", "venv"] html_css_files = ["literals.css"] -extensions = ["sphinx_rtd_theme"] templates_path = ["_templates"] html_context = { @@ -18,5 +17,5 @@ add_function_parentheses = True project = "Kreusada-Cogs" -copyright = "2020 - 2023 | Kreusada" +copyright = "2020 - 2024 | Kreusada" html_logo = "image_cog-creators-logo.png" diff --git a/docs/index.rst b/docs/index.rst index 49200cc68..6187e1dc7 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -11,7 +11,7 @@ Kreusada-Cogs This documentation is here for the support of my redbot cogs. Mention me in the #support_kreusada-cogs in the `cog support server `_ if you need any help. -You can also visit my `personal server `_ +You can also visit my `personal server `_. ============ Useful Links @@ -53,7 +53,4 @@ Useful Links :caption: Repository :maxdepth: 2 - repo_available_cogs_list repo_installation - repo_license - repo_support diff --git a/docs/repo_available_cogs_list.rst b/docs/repo_available_cogs_list.rst deleted file mode 100644 index d09d53dd3..000000000 --- a/docs/repo_available_cogs_list.rst +++ /dev/null @@ -1,6 +0,0 @@ -=================== -Available cogs list -=================== - -Please see `here `_ for the list of -available cogs. diff --git a/docs/repo_license.rst b/docs/repo_license.rst deleted file mode 100644 index 900785055..000000000 --- a/docs/repo_license.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. _license: - -======= -LICENSE -======= - -This repository and its cogs are registered under the MIT License. - -For further information, please click `here `_. - -Copyright (c) 2021 Kreusada diff --git a/docs/repo_support.rst b/docs/repo_support.rst deleted file mode 100644 index 098e98452..000000000 --- a/docs/repo_support.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. _support: - -======= -Support -======= - -Check out my docs `here `_. - -Mention me in the #support_kreusada-cogs in the `cog support server `_ if you need any help. - -Additionally, feel free to open an issue or pull request to this repo. diff --git a/flags/flags.py b/flags/flags.py index 5ddde7cab..d99546379 100644 --- a/flags/flags.py +++ b/flags/flags.py @@ -145,10 +145,10 @@ async def flag(self, ctx: Context, *, argument: CountryConverter): **Examples:** - - ``[p]flag russia`` - - ``[p]flag brazil`` - - ``[p]flag dk`` - - ``[p]flag se`` + - ``[p]flag russia`` + - ``[p]flag brazil`` + - ``[p]flag dk`` + - ``[p]flag se`` """ description = argument.pop("description", None) image = argument.pop("image") diff --git a/riddles/README.rst b/riddles/README.rst index 1c19a6f8d..459f3aa5b 100644 --- a/riddles/README.rst +++ b/riddles/README.rst @@ -32,8 +32,9 @@ Commands Here are all the commands included in this cog (1): -* ``[p]riddle`` - Get a random riddle. +Command Help +------------- -------------------- +``[p]riddle`` Get a random riddle. ------------ Installation diff --git a/texteditor/README.rst b/texteditor/README.rst index 7a583690c..cc83b7ffa 100644 --- a/texteditor/README.rst +++ b/texteditor/README.rst @@ -32,58 +32,61 @@ Commands Here are all the commands included in this cog (25): -* ``[p]editor`` - Base command for editing text. -* ``[p]editor alternating `` - Convert the text to alternating case. -* ``[p]editor bullet [items...]`` - Bullet point a selection of items. -* ``[p]editor charcount `` - Count the number of characters appearing in the text. -* ``[p]editor formatnumber `` - Format a number with commas. -* ``[p]editor levenshtein `` - Calculate the Levenshtein distance between two words. -* ``[p]editor lower `` - Convert the text to lowercase. -* ``[p]editor multiply `` - Multiply the text. -* ``[p]editor occurance `` - Count how many times something appears in the text. -* ``[p]editor palindrome `` - Checks for any palindromes within the text. -* ``[p]editor permutate `` - Generate permutations for given combinations of words/digits. -* ``[p]editor remove `` - Remove something from the text. -* ``[p]editor replace `` - Replace certain parts of the text. -* ``[p]editor reverse `` - Reverse the text. -* ``[p]editor shlex `` - Shlex split a given string. -* ``[p]editor shuffle `` - Shuffle the word order in the text. -* ``[p]editor snake `` - Convert all spaces to underscores. -* ``[p]editor squash `` - Squash all the words into one. -* ``[p]editor swapcase `` - Swap the casing for text. -* ``[p]editor title `` - Convert the text to titlecase. -* ``[p]editor trim [trimmer= ] `` - Trim the outskirts of the text. -* ``[p]editor typoglycemia `` - Scrambles all letters except the first and last letters in a word. - - Aoccdrnig to a rscheearch at Cmabrigde Uinervtisy, it deosn't mttaer in waht oredr the ltteers in a wrod are, the olny iprmoetnt tihng is taht the frist and lsat ltteer be at the rghit pclae. The rset can be a toatl mses and you can sitll raed it wouthit porbelm. Tihs is bcuseae the huamn mnid deos not raed ervey lteter by istlef, but the wrod as a wlohe. -* ``[p]editor upper `` - Convert the text to uppercase. -* ``[p]editor wordcount `` - Count the number of words appearing in the text. -* ``[p]editor wrap [cut_words=True] `` - Wrap the text. ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Command | Help | ++============================+=======================================================================================================================================================================================================================================================================================================================================================================+ +| ``[p]editor`` | Base command for editing text. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor alternating`` | Convert the text to alternating case. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor bullet`` | Bullet point a selection of items. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor charcount`` | Count the number of characters appearing in the text. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor formatnumber`` | Format a number with commas. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor levenshtein`` | Calculate the Levenshtein distance between two words. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor lower`` | Convert the text to lowercase. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor multiply`` | Multiply the text. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor occurance`` | Count how many times something appears in the text. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor palindrome`` | Checks for any palindromes within the text. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor permutate`` | Generate permutations for given combinations of words/digits. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor remove`` | Remove something from the text. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor replace`` | Replace certain parts of the text. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor reverse`` | Reverse the text. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor shlex`` | Shlex split a given string. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor shuffle`` | Shuffle the word order in the text. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor snake`` | Convert all spaces to underscores. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor squash`` | Squash all the words into one. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor swapcase`` | Swap the casing for text. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor title`` | Convert the text to titlecase. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor trim`` | Trim the outskirts of the text. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor typoglycemia`` | Scrambles all letters except the first and last letters in a word. | +| | | +| | Aoccdrnig to a rscheearch at Cmabrigde Uinervtisy, it deosn't mttaer in waht oredr the ltteers in a wrod are, the olny iprmoetnt tihng is taht the frist and lsat ltteer be at the rghit pclae. The rset can be a toatl mses and you can sitll raed it wouthit porbelm. Tihs is bcuseae the huamn mnid deos not raed ervey lteter by istlef, but the wrod as a wlohe. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor upper`` | Convert the text to uppercase. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor wordcount`` | Count the number of words appearing in the text. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``[p]editor wrap`` | Wrap the text. | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ------------ Installation