Skip to content

Commit d15210b

Browse files
committed
Revert "fix: try fixing failing ci"
This reverts commit 0eb533d.
1 parent 0eb533d commit d15210b

27 files changed

+170
-170
lines changed

docs/extensions/commands/groups.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ groups!
5050

5151
:::info Related Topics
5252

53-
- [Prefixed Commands](./prefixed-commands.mdx)
54-
- [Cogs](../../popular-topics/cogs)
53+
- [Prefixed Commands](./prefixed-commands.mdx)
54+
- [Cogs](../../popular-topics/cogs)
5555

5656
:::

docs/extensions/commands/help-command.mdx

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ Pycord bot. It is important to understand these two concepts before continuing.
2626

2727
**Learning Resources**:
2828

29-
- [W3Schools - Python Subclassing](https://www.w3schools.com/python/python_classes.asp)
30-
- [W3Schools - Python Inheritance](https://www.w3schools.com/python/python_inheritance.asp)
29+
- [W3Schools - Python Subclassing](https://www.w3schools.com/python/python_classes.asp)
30+
- [W3Schools - Python Inheritance](https://www.w3schools.com/python/python_inheritance.asp)
3131

3232
:::
3333

@@ -54,8 +54,8 @@ of making one with Pycord. Making a help command with subclassing and OOP will s
5454

5555
There are two types of built-in help commands:
5656

57-
- [`DefaultHelpCommand`](https://docs.pycord.dev/en/stable/ext/commands/api.html#discord.ext.commands.DefaultHelpCommand)
58-
- [`MinimalHelpCommand`](https://docs.pycord.dev/en/stable/ext/commands/api.html#discord.ext.commands.MinimalHelpCommand)
57+
- [`DefaultHelpCommand`](https://docs.pycord.dev/en/stable/ext/commands/api.html#discord.ext.commands.DefaultHelpCommand)
58+
- [`MinimalHelpCommand`](https://docs.pycord.dev/en/stable/ext/commands/api.html#discord.ext.commands.MinimalHelpCommand)
5959

6060
`DefaultHelpCommand` is the command enabled by default. It isn't the best looking, but `MinimalHelpCommand` can help make it look a bit better.
6161

@@ -194,10 +194,10 @@ For this, we will subclass the `HelpCommand` class.
194194

195195
There are 4 methods that we need to override:
196196

197-
- `HelpCommand.send_bot_help(mapping)` that gets called with `<prefix>help`
198-
- `HelpCommand.send_command_help(command)` that gets called with `<prefix>help <command>`
199-
- `HelpCommand.send_group_help(group)` that gets called with `<prefix>help <group>`
200-
- `HelpCommand.send_cog_help(cog)` that gets called with `<prefix>help <cog>`
197+
- `HelpCommand.send_bot_help(mapping)` that gets called with `<prefix>help`
198+
- `HelpCommand.send_command_help(command)` that gets called with `<prefix>help <command>`
199+
- `HelpCommand.send_group_help(group)` that gets called with `<prefix>help <group>`
200+
- `HelpCommand.send_cog_help(cog)` that gets called with `<prefix>help <cog>`
201201

202202
### Bot Help
203203

@@ -219,27 +219,27 @@ bot.help_command = MyHelp()
219219

220220
Let's go through the code.
221221

222-
- First, we create a new class called `MyHelp`. This class is a subclass of `HelpCommand`.
222+
- First, we create a new class called `MyHelp`. This class is a subclass of `HelpCommand`.
223223

224-
- Next, we override the `send_bot_help` method. This method is responsible for sending the main help
224+
- Next, we override the `send_bot_help` method. This method is responsible for sending the main help
225225
command to the user.
226226

227-
- We create an embed with the title "Help".
227+
- We create an embed with the title "Help".
228228

229-
- We iterate through `mapping.items()`, which returns a list of tuples, the first element being the
229+
- We iterate through `mapping.items()`, which returns a list of tuples, the first element being the
230230
cog and the second element being a list of commands.
231231

232-
- By using `self.get_command_signature(c)` we get the signature of the command, also known as the
232+
- By using `self.get_command_signature(c)` we get the signature of the command, also known as the
233233
`parameters` or `arguments`.
234234

235-
- There is a chance that the cog is empty, so we use `if command_signatures:`.
235+
- There is a chance that the cog is empty, so we use `if command_signatures:`.
236236

237-
- We get the name of the cog using `getattr(cog, "qualified_name", "No Category")`. This calls the
237+
- We get the name of the cog using `getattr(cog, "qualified_name", "No Category")`. This calls the
238238
cog's attribute `qualified_name` which returns "No Category" if the cog has no name.
239239

240-
- We add a field to the embed with the name of the cog and the value of the command signatures.
240+
- We add a field to the embed with the name of the cog and the value of the command signatures.
241241

242-
- Finally, we send the embed to the channel.
242+
- Finally, we send the embed to the channel.
243243

244244
Let's improve the code a little.
245245

@@ -289,10 +289,10 @@ bot.help_command = MyHelp()
289289

290290
Let's quickly go through the code we haven't discussed yet.
291291

292-
- In line 3, we create an embed with a title the signature of the command (so that the title of the
292+
- In line 3, we create an embed with a title the signature of the command (so that the title of the
293293
embed looks like `<command> <parameter> [parameter]`), and a random color.
294294

295-
- In lines 4 and 5, we get the command's `help` description and add it to the embed. The help description
295+
- In lines 4 and 5, we get the command's `help` description and add it to the embed. The help description
296296
of a command can be specified in the docstrings of a command function. For example:
297297

298298
```python
@@ -302,7 +302,7 @@ of a command can be specified in the docstrings of a command function. For examp
302302
await ctx.send(f"Pong! {round(bot.latency * 1000)}ms")
303303
```
304304

305-
- Line 6 is shorthand for
305+
- Line 6 is shorthand for
306306

307307
```python
308308
alias = command.aliases
@@ -317,7 +317,7 @@ of a command can be specified in the docstrings of a command function. For examp
317317

318318
A very helpful (but not well-known) Python shorthand!
319319

320-
- In line 7, we get the aliases of the command and add them to the embed.
320+
- In line 7, we get the aliases of the command and add them to the embed.
321321

322322
### Cog Help
323323

@@ -472,8 +472,8 @@ Thanks to InterStella0 for making this guide amazing.
472472

473473
:::info Related Topics
474474

475-
- [Subclassing Bots](../../Popular-Topics/subclassing-bots)
476-
- [Prefixed Commands](./prefixed-commands)
477-
- [Cogs](../../popular-topics/cogs)
475+
- [Subclassing Bots](../../Popular-Topics/subclassing-bots)
476+
- [Prefixed Commands](./prefixed-commands)
477+
- [Cogs](../../popular-topics/cogs)
478478

479479
:::

docs/extensions/commands/prefixed-commands.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,11 @@ The syntax becomes a little more complicated when you want to have multiple comm
2727
disadvantages to this system. This is where the commands extension comes in. `ext.commands` has
2828
various advantages, such as:
2929

30-
- Simpler syntax
31-
- Easier to use
32-
- Easier to parse user input
33-
- Comes with built-in help commands
34-
- Comes with a built-in system for categorizing commands
30+
- Simpler syntax
31+
- Easier to use
32+
- Easier to parse user input
33+
- Comes with built-in help commands
34+
- Comes with a built-in system for categorizing commands
3535

3636
<Tabs>
3737
<TabItem value="0" label="Using Events to Create Prefixed Commands" default>
@@ -317,7 +317,7 @@ with `int(guess)`.
317317

318318
:::info Related Topics
319319

320-
- [Command Groups](groups)
321-
- [Rules and Common Practices](../../Getting-Started/rules-and-common-practices)
320+
- [Command Groups](groups)
321+
- [Rules and Common Practices](../../Getting-Started/rules-and-common-practices)
322322

323323
:::

docs/extensions/pages/paginator-basics.mdx

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -60,33 +60,33 @@ to send a message or response with the paginator's contents.
6060

6161
#### Depending on what's being passed to the `pages` parameter, the behaviour of the paginator may differ:
6262

63-
- Passing a list of `PageGroup` objects will essentially treat each `PageGroup` as its own Paginator, with most
63+
- Passing a list of `PageGroup` objects will essentially treat each `PageGroup` as its own Paginator, with most
6464
`Paginator` attributes able to be set independently for each `PageGroup`.
65-
- Each `PageGroup` accepts its own `pages` parameter, which inherits the same behaviour as the `pages` parameter
65+
- Each `PageGroup` accepts its own `pages` parameter, which inherits the same behaviour as the `pages` parameter
6666
of `Paginator`, except it cannot contain other `PageGroup` objects.
67-
- If a page is a `Page` object, this will allow you to specify both the `discord.Message.content` and
67+
- If a page is a `Page` object, this will allow you to specify both the `discord.Message.content` and
6868
`discord.Message.embeds` attributes for a page.
69-
- **This is the preferred method of defining a page.**
70-
- If a page is a string, this will be used for the `discord.Message.content` attribute. This type of page cannot have
69+
- **This is the preferred method of defining a page.**
70+
- If a page is a string, this will be used for the `discord.Message.content` attribute. This type of page cannot have
7171
any embeds.
72-
- If a page is a list of embeds, this will be used for the `discord.Message.embeds` attribute. This type of page
72+
- If a page is a list of embeds, this will be used for the `discord.Message.embeds` attribute. This type of page
7373
cannot have any message content.
74-
- If a page is a list of lists of embeds, each parent list item will create a page containing all embeds from its
74+
- If a page is a list of lists of embeds, each parent list item will create a page containing all embeds from its
7575
child list. This type of page cannot have any message content.
7676

7777
#### Parameters for the `Paginator` class which have default values:
78-
- `show_disabled` **:** `True`
79-
- Show buttons that are disabled (i.e. can't be clicked)
80-
- `author_check` **:** `True`
81-
- Only the author can interact with the paginator.
82-
- `timeout` **:** `180` *(seconds)*
83-
- The paginator will time out and become inactive after this many seconds.
84-
- `disable_on_timeout` **:** `True`
85-
- If the paginator times out, it will be automatically disabled and all buttons will be unusable.
86-
- `use_default_buttons` **:** `True`
87-
- Use the default set of 4 buttons and a page indicator.
88-
- `show_indicator` **:** `True`
89-
- When using the default buttons, shows a middle 5th button with the current/total page numbers.
78+
- `show_disabled` **:** `True`
79+
- Show buttons that are disabled (i.e. can't be clicked)
80+
- `author_check` **:** `True`
81+
- Only the author can interact with the paginator.
82+
- `timeout` **:** `180` *(seconds)*
83+
- The paginator will time out and become inactive after this many seconds.
84+
- `disable_on_timeout` **:** `True`
85+
- If the paginator times out, it will be automatically disabled and all buttons will be unusable.
86+
- `use_default_buttons` **:** `True`
87+
- Use the default set of 4 buttons and a page indicator.
88+
- `show_indicator` **:** `True`
89+
- When using the default buttons, shows a middle 5th button with the current/total page numbers.
9090

9191
**For other parameters that can be set on initialization, please check the
9292
[API Reference](https://docs.pycord.dev/en/stable/ext/pages/index.html#paginator)**

docs/extensions/pages/paginator-faq.mdx

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ title: Paginator FAQ
44

55
# Paginator FAQ
66

7-
- **What's the difference between `Paginator.send()` and `Paginator.respond()`?**
8-
- `Paginator.send()` is used to send a channel message (DMChannel or TextChannel) with the paginator.
9-
- `Paginator.respond()` is used to send an interaction response (or followup) message with the paginator.
7+
- **What's the difference between `Paginator.send()` and `Paginator.respond()`?**
8+
- `Paginator.send()` is used to send a channel message (DMChannel or TextChannel) with the paginator.
9+
- `Paginator.respond()` is used to send an interaction response (or followup) message with the paginator.
1010

11-
- **How can the bot send a paginator to a different destination than where it was invoked?**
12-
- Use the `target` parameter in `Paginator.send()` or `Paginator.respond()`.
13-
- You can also set the `target_message` parameter to control what's shown as a response where the paginator was originally invoked.
14-
- For `Paginator.respond()`, this parameter is required if `target` is set, as an interaction requires being responded to.
15-
- **How can I change the paginator's behavior without re-creating and re-sending it?**
16-
- Use the `Paginator.update()` method.
17-
- **How can I make the bot actually do something with the contents of a page?**
18-
- Use the (upcoming) `Paginator.page_action()` method.
11+
- **How can the bot send a paginator to a different destination than where it was invoked?**
12+
- Use the `target` parameter in `Paginator.send()` or `Paginator.respond()`.
13+
- You can also set the `target_message` parameter to control what's shown as a response where the paginator was originally invoked.
14+
- For `Paginator.respond()`, this parameter is required if `target` is set, as an interaction requires being responded to.
15+
- **How can I change the paginator's behavior without re-creating and re-sending it?**
16+
- Use the `Paginator.update()` method.
17+
- **How can I make the bot actually do something with the contents of a page?**
18+
- Use the (upcoming) `Paginator.page_action()` method.

docs/extensions/tasks/tasks.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -88,11 +88,11 @@ These are all really useful, and they aren't the only parameters so if you want
8888
### Attributes
8989

9090
A task has the following attributes:
91-
- `current_loop`: The current loop the task is on.
92-
- `hours`, `minutes`, `seconds`: attributes that represent the time between each execution.
93-
- `time`: A list of datetime.time objects that represent the times the task will run, returns `None` if no datetime
91+
- `current_loop`: The current loop the task is on.
92+
- `hours`, `minutes`, `seconds`: attributes that represent the time between each execution.
93+
- `time`: A list of datetime.time objects that represent the times the task will run, returns `None` if no datetime
9494
objects were passed.
95-
- `next_iteration`: A `datetime.datetime` object that represents the next time the next iteration of the task will
95+
- `next_iteration`: A `datetime.datetime` object that represents the next time the next iteration of the task will
9696
run, can return `None` if the task stopped running.
9797

9898
These attributes serve as a really powerful asset to get info about your loop.

docs/getting-started/creating-your-first-bot.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -259,6 +259,6 @@ To learn more, read about Message Commands in our [interactions directory](../in
259259

260260
:::info Related Topics
261261

262-
- [Prefixed Commands](../extensions/commands/prefixed-commands)
262+
- [Prefixed Commands](../extensions/commands/prefixed-commands)
263263

264264
:::

docs/getting-started/hosting-your-bot.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,6 @@ a short time.
104104

105105
:::info Related Topics
106106

107-
- [Creating Your First Bot](creating-your-first-bot)
107+
- [Creating Your First Bot](creating-your-first-bot)
108108

109109
:::

docs/getting-started/more-features.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -213,14 +213,14 @@ embed.set_image(url="https://example.com/link-to-my-banner.png")
213213
```
214214

215215
In this section, we're adding unique items to the embed. These items are:
216-
- Footer - With the [`set_footer()`](https://docs.pycord.dev/en/stable/api/data_classes.html#discord.Embed.set_footer)
216+
- Footer - With the [`set_footer()`](https://docs.pycord.dev/en/stable/api/data_classes.html#discord.Embed.set_footer)
217217
method, you can set a small footer that holds a message. This has `text` and `icon_url` kwargs.
218-
- Author - With the [`set_author`](https://docs.pycord.dev/en/stable/api/data_classes.html#discord.Embed.set_author)
218+
- Author - With the [`set_author`](https://docs.pycord.dev/en/stable/api/data_classes.html#discord.Embed.set_author)
219219
method, you can set an author for the embed. This is a small text field at the top of the embed. This
220220
includes `name`, `url` and `icon_url` kwargs.
221-
- Thumbnail - With the [`set_thumbnail`](https://docs.pycord.dev/en/stable/api/data_classes.html#discord.Embed.set_thumbnail)
221+
- Thumbnail - With the [`set_thumbnail`](https://docs.pycord.dev/en/stable/api/data_classes.html#discord.Embed.set_thumbnail)
222222
method, you can set a small image to reside at the top-right of the embed. This has a single `url` kwarg.
223-
- Image - With the [`set_image`](https://docs.pycord.dev/en/stable/api/data_classes.html#discord.Embed.set_image)
223+
- Image - With the [`set_image`](https://docs.pycord.dev/en/stable/api/data_classes.html#discord.Embed.set_image)
224224
method, you can set an image to sit at the bottom of an embed. This has a single `url` kwarg.
225225

226226
There are a lot more methods and attributes you can use to configure embeds. Here, we just covered the basics. Also, remember that all of these values are not necessary in an embed. An embed may only contain a few of these. For example, only a description, a title and a description, and so on.

docs/interactions/application-commands/context-menus.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ async def get_message_id(ctx, message: discord.Message): # message commands ret
7979

8080
:::info Related Topics
8181

82-
- [Slash Commands](./slash-commands)
83-
- [Interactions Index](../../interactions)
82+
- [Slash Commands](./slash-commands)
83+
- [Interactions Index](../../interactions)
8484

8585
:::

docs/interactions/application-commands/localizations.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,4 +53,4 @@ async def ping2(ctx, example: Option(str, "example", name_localizations={"en-GB"
5353
```
5454

5555

56-
- [`Locales`](https://discord.com/developers/docs/reference#locales) - List of valid locales recognized by Discord
56+
- [`Locales`](https://discord.com/developers/docs/reference#locales) - List of valid locales recognized by Discord

docs/interactions/application-commands/slash-commands.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -284,8 +284,8 @@ Autocomplete can **only** be used with slash commands.
284284

285285
:::info Related Topics
286286

287-
- [Interactions Index](../../interactions)
288-
- [Rules and Common Practices](../../getting-started/rules-and-common-practices)
289-
- [Cogs](../../popular-topics/cogs)
287+
- [Interactions Index](../../interactions)
288+
- [Rules and Common Practices](../../getting-started/rules-and-common-practices)
289+
- [Cogs](../../popular-topics/cogs)
290290

291291
:::

docs/interactions/index.mdx

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -19,21 +19,21 @@ Since then, Discord has added many types of Interactions, including:
1919

2020
[**Application Commands**](https://discord.com/developers/docs/interactions/application-commands)
2121

22-
- [**Slash Commands**](https://discord.com/developers/docs/interactions/application-commands#slash-commands):
22+
- [**Slash Commands**](https://discord.com/developers/docs/interactions/application-commands#slash-commands):
2323
Commands that can be used with the `/` prefix.
24-
- **Context Menu Commands**: Commands that can be used from the right-click menu.
25-
- [**User Commands**](https://discord.com/developers/docs/interactions/application-commands#user-commands):
24+
- **Context Menu Commands**: Commands that can be used from the right-click menu.
25+
- [**User Commands**](https://discord.com/developers/docs/interactions/application-commands#user-commands):
2626
Commands that can be used on a user by alt-clicking/selecting them.
27-
- [**Message Commands**](https://discord.com/developers/docs/interactions/application-commands#message-commands):
27+
- [**Message Commands**](https://discord.com/developers/docs/interactions/application-commands#message-commands):
2828
Commands that can be used on a message by alt-clicking/selecting it.
2929

3030
[**UI Components**](https://discord.com/developers/docs/interactions/message-components)
3131

32-
- [**Buttons**](https://discord.com/developers/docs/interactions/message-components#buttons):
32+
- [**Buttons**](https://discord.com/developers/docs/interactions/message-components#buttons):
3333
Buttons are attached to a message and can be clicked on to perform an action.
34-
- [**Select Menus**](https://discord.com/developers/docs/interactions/message-components#select-menus):
34+
- [**Select Menus**](https://discord.com/developers/docs/interactions/message-components#select-menus):
3535
Drop-down menus are used to select a number of options from a list.
36-
- [**Modals**](https://discord.com/developers/docs/interactions/message-components#text-inputs):
36+
- [**Modals**](https://discord.com/developers/docs/interactions/message-components#text-inputs):
3737
Form-like modals can be used to ask for input from a user.
3838

3939
## Application Commands
@@ -69,11 +69,11 @@ Message Content intent. Using that as a reason will get your application denied.
6969
This is what a Slash Command looks like. Not too different from a prefix command,
7070
apart from the note telling you who invoked it. A Slash Command's fields can accept any of the following:
7171

72-
- Members
73-
- Roles
74-
- Channels
75-
- Attachments
76-
- Text
72+
- Members
73+
- Roles
74+
- Channels
75+
- Attachments
76+
- Text
7777

7878
Just about as good as it gets.
7979

0 commit comments

Comments
 (0)