Skip to content

Commit 4cbc746

Browse files
committed
Update documentation
1 parent 2f924a1 commit 4cbc746

File tree

2 files changed

+56
-11
lines changed

2 files changed

+56
-11
lines changed

docs/cog_guides/core.rst

Lines changed: 50 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2958,25 +2958,70 @@ set bot custominfo
29582958

29592959
.. code-block:: none
29602960
2961-
[p]set bot custominfo [text]
2961+
[p]set bot custominfo
29622962
29632963
**Description**
29642964

2965-
Customizes a section of ``[p]info``.
2965+
Customizes sections of `[p]info`.
2966+
2967+
.. _core-command-set-bot-custominfo-text:
2968+
2969+
"""""""""""""""""""""""
2970+
set bot custominfo text
2971+
"""""""""""""""""""""""
2972+
2973+
**Syntax**
2974+
2975+
.. code-block:: none
2976+
2977+
[p]set bot custominfo text [text]
2978+
2979+
**Description**
2980+
2981+
Customizes a section of optional text in `[p]info`.
29662982

29672983
The maximum amount of allowed characters is 1024.
29682984
Supports markdown, links and "mentions".
29692985

29702986
Link example: ``[My link](https://example.com)``
29712987

29722988
**Examples:**
2973-
- ``[p]set bot custominfo >>> I can use **markdown** such as quotes, ||spoilers|| and multiple lines.``
2974-
- ``[p]set bot custominfo Join my [support server](discord.gg/discord)!``
2975-
- ``[p]set bot custominfo`` - Removes custom info text.
2989+
- ``[p]set bot custominfo text >>> I can use **markdown** such as quotes, ||spoilers|| and multiple lines.``
2990+
- ``[p]set bot custominfo text Join my [support server](discord.gg/discord)!``
2991+
- ``[p]set bot custominfo text`` - Removes custom info text.
29762992

29772993
**Arguments:**
29782994
- ``[text]`` - The custom info text.
29792995

2996+
.. _core-command-set-bot-custominfo-image:
2997+
2998+
""""""""""""""""""""""""
2999+
set bot custominfo image
3000+
""""""""""""""""""""""""
3001+
3002+
**Syntax**
3003+
3004+
.. code-block:: none
3005+
3006+
[p]set bot custominfo text [text]
3007+
3008+
**Description**
3009+
3010+
Customizes an optional image sent inside the `[p]info` embed.
3011+
3012+
You may provide an image URL or send an attachment.
3013+
Sending neither will remove the image from the embed.
3014+
3015+
Images are not sent if embeds are disabled.
3016+
3017+
**Examples:**
3018+
- `[p]set bot custominfo image https://imgur.com/pY1WUFX.png`
3019+
- `[p]set bot custominfo image <image attachment>`
3020+
- `[p]set bot custominfo image` - Removes custom image.
3021+
3022+
**Arguments:**
3023+
- `[url]` - The URL of the image.
3024+
29803025
.. _core-command-set-bot-description:
29813026

29823027
"""""""""""""""""""

redbot/core/core_commands.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3105,9 +3105,9 @@ async def _set_bot_custominfo_text(self, ctx: commands.Context, *, text: str = N
31053105
Link example: `[My link](https://example.com)`
31063106
31073107
**Examples:**
3108-
- `[p]set bot custominfo >>> I can use **markdown** such as quotes, ||spoilers|| and multiple lines.`
3109-
- `[p]set bot custominfo Join my [support server](discord.gg/discord)!`
3110-
- `[p]set bot custominfo` - Removes custom info text.
3108+
- `[p]set bot custominfo text >>> I can use **markdown** such as quotes, ||spoilers|| and multiple lines.`
3109+
- `[p]set bot custominfo text Join my [support server](discord.gg/discord)!`
3110+
- `[p]set bot custominfo text` - Removes custom info text.
31113111
31123112
**Arguments:**
31133113
- `[text]` - The custom info text.
@@ -3133,9 +3133,9 @@ async def _set_bot_custominfo_image(self, ctx: commands.Context, *, url: str = N
31333133
Images are not sent if embeds are disabled.
31343134
31353135
**Examples:**
3136-
- `[p]set bot infoimage https://imgur.com/pY1WUFX.png`
3137-
- `[p]set bot infoimage <image attachment>`
3138-
- `[p]set bot infoimage` - Removes custom image.
3136+
- `[p]set bot custominfo image https://imgur.com/pY1WUFX.png`
3137+
- `[p]set bot custominfo image <image attachment>`
3138+
- `[p]set bot custominfo image` - Removes custom image.
31393139
31403140
**Arguments:**
31413141
- `[url]` - The URL of the image.

0 commit comments

Comments
 (0)