Skip to content

Commit e7e7458

Browse files
authored
Merge pull request #284 from AesirIvy/main
Fix broken links
2 parents 06486b3 + 0a7e799 commit e7e7458

File tree

11 files changed

+47
-47
lines changed

11 files changed

+47
-47
lines changed

docs/extensions/commands/help-command.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -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/api.html#discord.ext.commands.DefaultHelpCommand)
58-
- [`MinimalHelpCommand`](https://docs.pycord.dev/en/stable/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

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -173,9 +173,9 @@ Next, we load the env file with `load_dotenv()`.
173173
bot = discord.Bot()
174174
```
175175

176-
In this line, we create a new instance of [`discord.Bot`](https://docs.pycord.dev/en/stable/api.html#discord.Bot).
176+
In this line, we create a new instance of [`discord.Bot`](https://docs.pycord.dev/en/stable/api/clients.html#discord.Bot).
177177
In this object, we can pass various parameters for configuration purposes, such as `owner_ids`
178-
and [`intents`](https://docs.pycord.dev/en/stable/api.html?highlight=get_message#discord.Intents).
178+
and [`intents`](https://docs.pycord.dev/en/stable/api/data_classes.html#discord.Intents).
179179

180180

181181

@@ -185,8 +185,8 @@ async def on_ready():
185185
print(f"{bot.user} is ready and online!")
186186
```
187187

188-
We use the [`event`](https://docs.pycord.dev/en/stable/api.html#discord.Bot.event) decorator to override
189-
the [`on_ready`](https://docs.pycord.dev/en/stable/api.html#discord.on_ready) function to define an
188+
We use the [`event`](https://docs.pycord.dev/en/stable/api/clients.html#discord.Bot.event) decorator to override
189+
the [`on_ready`](https://docs.pycord.dev/en/stable/api/events.html#discord.on_ready) function to define an
190190
event that is automatically called when the bot is ready to use.
191191

192192
```py
@@ -195,7 +195,7 @@ async def say_hello(ctx):
195195
await ctx.respond("Hey!")
196196
```
197197

198-
Here, we use the [`slash_command`](https://docs.pycord.dev/en/stable/api.html#discord.Bot.slash_command)
198+
Here, we use the [`slash_command`](https://docs.pycord.dev/en/stable/api/clients.html#discord.Bot.slash_command)
199199
decorator to define a slash command. We specify the `name` and `description` arguments. If not
200200
specified, the name of the slash command would be the function name and the command description would
201201
be empty.

docs/getting-started/more-features.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ So, that's how you add event handlers!
4545

4646
### Waiting for User Response
4747

48-
Let's say you want to create a Guess-the-Number game (where the user has to guess a number between 1-10). You need to send a message to a user and wait for them to respond. You can do this with the [`wait_for`](https://docs.pycord.dev/en/stable/api.html#discord.Bot.wait_for) method.
48+
Let's say you want to create a Guess-the-Number game (where the user has to guess a number between 1-10). You need to send a message to a user and wait for them to respond. You can do this with the [`wait_for`](https://docs.pycord.dev/en/stable/api/clients.html#discord.Bot.wait_for) method.
4949

5050
```python
5151
@bot.command()
@@ -114,7 +114,7 @@ enabling your bot to lay out messages with a lot of text into neat fields.
114114

115115
<br/>
116116

117-
Creating embeds is simple! Just create an instance of [`discord.Embed`](https://docs.pycord.dev/en/stable/api.html#discord.Embed) and edit it to your liking. Once you're done, send it!
117+
Creating embeds is simple! Just create an instance of [`discord.Embed`](https://docs.pycord.dev/en/stable/api/data_classes.html#discord.Embed) and edit it to your liking. Once you're done, send it!
118118

119119
```python
120120
import discord
@@ -187,10 +187,10 @@ embed = discord.Embed(
187187
)
188188
```
189189

190-
This command creates an embed. We use the [`Embed`](https://docs.pycord.dev/en/stable/api.html#discord.Embed)
190+
This command creates an embed. We use the [`Embed`](https://docs.pycord.dev/en/stable/api/data_classes.html#discord.Embed)
191191
class to create an embed object with the title "My Amazing Embed", the description "Embeds are super easy, barely an inconvenience.", and the color `blurple`, Discord's main theme color.
192192

193-
[discord.Colour](https://docs.pycord.dev/en/stable/api.html#colour) is a class full of [classmethods](https://docs.python.org/3/library/functions.html#classmethod)
193+
[discord.Colour](https://docs.pycord.dev/en/stable/api/data_classes.html#discord.Colour) is a class full of [classmethods](https://docs.python.org/3/library/functions.html#classmethod)
194194
that return color values. While the official, documented name of this is `discord.Colour`, `discord.Color`
195195
works as well.
196196

@@ -201,8 +201,8 @@ embed.add_field(title="Inline Field 2", value="Inline Field 2", inline=True)
201201
embed.add_field(title="Inline Field 3", value="Inline Field 3", inline=True)
202202
```
203203

204-
This small section shows off embed fields. You can add fields to embeds with the [`add_field` method](https://docs.pycord.dev/en/stable/api.html#discord.Embed.add_field)
205-
of the [`discord.Embed`](https://docs.pycord.dev/en/stable/api.html#embed) class. These consist of three
204+
This small section shows off embed fields. You can add fields to embeds with the [`add_field` method](https://docs.pycord.dev/en/stable/api/data_classes.html#discord.Embed.add_field)
205+
of the [`discord.Embed`](https://docs.pycord.dev/en/stable/api/data_classes.html#discord.Embed) class. These consist of three
206206
keyword arguments: `title`, `value`, and `inline`. `title` and `value` are both required arguments, which inline defaults to `False` if it's not defined. The `inline` argument specifies whether space will be divided among the inline fields. There could be a mix of fields where inline has different values too.
207207

208208
```py
@@ -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.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.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.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.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/slash-commands.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,11 +62,11 @@ Let's go through the code.
6262

6363
First, we import Pycord's `discord` package.
6464

65-
Next, we create a [`discord.Bot`](https://docs.pycord.dev/en/stable/api.html#discord.Bot) object and assign it to a variable `bot`.
65+
Next, we create a [`discord.Bot`](https://docs.pycord.dev/en/stable/api/clients.html#discord.Bot) object and assign it to a variable `bot`.
6666

67-
We then go ahead and use the [`@bot.command`](https://docs.pycord.dev/en/stable/api.html#discord.Bot.command) decorator, which registers a new Slash Command. We pass a `description` parameter to give a description to the Slash Command. We can also pass a `name` parameter to change the Slash Command's name. By default, the name of the Slash Command will be the name of the function, in this case, `/ping`.
67+
We then go ahead and use the [`@bot.command`](https://docs.pycord.dev/en/stable/api/clients.html#discord.Bot.command) decorator, which registers a new Slash Command. We pass a `description` parameter to give a description to the Slash Command. We can also pass a `name` parameter to change the Slash Command's name. By default, the name of the Slash Command will be the name of the function, in this case, `/ping`.
6868

69-
We create an async function called `ping` with parameters `ctx`, which, when called, sends the bot's ping/latency using [`ctx.respond`](https://docs.pycord.dev/en/stable/api.html#discord.ApplicationContext.respond).
69+
We create an async function called `ping` with parameters `ctx`, which, when called, sends the bot's ping/latency using [`ctx.respond`](https://docs.pycord.dev/en/stable/api/application_commands.html#discord.ApplicationContext.respond).
7070

7171
## Subcommand Groups
7272

@@ -179,7 +179,7 @@ bot.run("TOKEN")
179179
</TabItem>
180180
<TabItem value="1" label="Using the SlashCommandOptionType enum">
181181

182-
You could also explicitly declare the type using the [`SlashCommandOptionType`](https://docs.pycord.dev/en/stable/api.html#discord.SlashCommandOptionType) enum.
182+
You could also explicitly declare the type using the [`SlashCommandOptionType`](https://docs.pycord.dev/en/stable/api/enums.html#discord.SlashCommandOptionType) enum.
183183

184184
```python title="Slash Command Type"
185185
import discord

docs/interactions/index.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Form-like modals can be used to ask for input from a user.
4141
Application Commands are another set of new features that are intended to avoid compromising users' safety and privacy.
4242
They're relatively easy to add to your bot, and give people a simpler and safer way to use commands.
4343

44-
### [Slash Commands](https://docs.pycord.dev/en/stable/api.html#slashcommand)
44+
### [Slash Commands](https://docs.pycord.dev/en/stable/api/application_commands.html#discord.SlashCommand)
4545

4646
Slash Commands were the first Interaction added to Discord. They're easy to use and create, and
4747
is the only prefix commands alternative that does not need Message Content intent.
@@ -77,7 +77,7 @@ apart from the note telling you who invoked it. A Slash Command's fields can acc
7777

7878
Just about as good as it gets.
7979

80-
### [Message](https://docs.pycord.dev/en/stable/api.html#messagecommand) and [User](https://docs.pycord.dev/en/stable/api.html#usercommand) Commands
80+
### [Message](https://docs.pycord.dev/en/stable/api/application_commands.html#discord.MessageCommand) and [User](https://docs.pycord.dev/en/stable/api/application_commands.html#discord.UserCommand) Commands
8181

8282
Message Commands and User Commands were both introduced at around the same time, and are very similar to each other, so we'll be
8383
introducing them together. These commands can be found in the `Apps` tab when alt-clicking. The only difference between the two is that
@@ -181,10 +181,10 @@ Message Components are fairly new features in Discord, allowing developers to gi
181181
and understandable user interface. Message Components are easy to use and make your bot look modern,
182182
sleek, and downright awesome.
183183

184-
### [Views](https://docs.pycord.dev/en/stable/api.html#discord.ui.View)
184+
### [Views](https://docs.pycord.dev/en/stable/api/ui_kit.html#discord.ui.View)
185185

186186
Views are not an Application Command nor are they a Message Component. Views are the invisible placeholders, or grid,
187-
that Message Components lie in. Views can have up to 5 [`Action Rows`](https://docs.pycord.dev/en/stable/api.html#discord.ActionRow),
187+
that Message Components lie in. Views can have up to 5 [`Action Rows`](https://docs.pycord.dev/en/stable/api/models.html#discord.ActionRow),
188188
and Action Rows can have a maximum of 5 slots. Below, you can find a table showing how many slots a Message Interaction takes up.
189189

190190
| Component | Slots |
@@ -197,7 +197,7 @@ So, based on this, you could have a maximum of 25 Buttons in a View with no Sele
197197
Menus in a View with no Buttons. This doesn't mean you can't have them both in a View, however. You can have
198198
a combination of them, such as 20 Buttons and a Select Menu or 10 Buttons and 3 Select Menus.
199199

200-
### [Buttons](https://docs.pycord.dev/en/stable/api.html#discord.ui.Button)
200+
### [Buttons](https://docs.pycord.dev/en/stable/api/ui_kit.html#discord.ui.Button)
201201

202202
Buttons are the first of the Message Components. They allow for quick responses to prompts, such as for canceling or continuing an action.
203203
Of course, these aren't their only uses; people have created awesome things with Buttons, such as calculators, games, and more!
@@ -218,7 +218,7 @@ Of course, these aren't their only uses; people have created awesome things with
218218
This is what a Button looks like, very simple and modern. To learn more about Buttons, refer to our
219219
[Buttons page](./ui-components/buttons.mdx).
220220

221-
### [Select Menus](https://docs.pycord.dev/en/stable/api.html#discord.ui.Select)
221+
### [Select Menus](https://docs.pycord.dev/en/stable/api/ui_kit.html#discord.ui.Select)
222222

223223
Select Menus are the second of Discord's Message Components. They allow users to select from a list of choices, which your bot can then use.
224224
Select Menus are good for things such as choosing features, pages of a help menu, and more.
@@ -229,7 +229,7 @@ This is what a Select Menu looks like. While not looking as good as Buttons, the
229229
and have even greater possibilities. To learn more about Select Menus, please refer to our [Select
230230
Menus page](./ui-components/dropdowns.mdx).
231231

232-
### [Modal Dialogs](https://docs.pycord.dev/en/stable/api.html#discord.ui.Modal)
232+
### [Modal Dialogs](https://docs.pycord.dev/en/stable/api/ui_kit.html#discord.ui.Modal)
233233

234234
Text Modals are the most recently added Message Component in Discord. They're useful for text input and filling out forms, such as a
235235
sign-up for your bot's service. These are meant to replace long bot setup processes by allowing users to fill out multiple text fields,

docs/interactions/ui-components/buttons.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -74,13 +74,13 @@ Using this command should return the following message:
7474
<br />
7575

7676
As you can see, we create a class called `MyView` that [subclasses](#oop)
77-
[`discord.ui.View`](https://docs.pycord.dev/en/stable/api.html#discord.ui.View).
77+
[`discord.ui.View`](https://docs.pycord.dev/en/stable/api/ui_kit.html#discord.ui.View).
7878

7979
Then, we add a function called `button_callback` to the `MyView` class with the decorator
80-
[`discord.ui.button`](https://docs.pycord.dev/en/stable/api.html#discord.ui.button).
80+
[`discord.ui.button`](https://docs.pycord.dev/en/stable/api/ui_kit.html#discord.ui.Button).
8181
This decorator adds a button to a component. This function takes two arguments: the button that was
8282
clicked and the interaction. These arguments are passed to the function when the button is clicked
83-
by the module. We use the [`interaction.response.send_message`](https://docs.pycord.dev/en/stable/api.html#discord.InteractionResponse.send_message)
83+
by the module. We use the [`interaction.response.send_message`](https://docs.pycord.dev/en/stable/api/models.html#discord.InteractionResponse.send_message)
8484
function to send a message to the channel where the interaction was sent.
8585

8686
Finally, we create a global slash command called `button` that sends the message, along with the view
@@ -101,11 +101,11 @@ about making your button do amazing things, while Pycord handles the rest!
101101
| Danger | `discord.ButtonStyle.danger` / `discord.ButtonStyle.red` | Red |
102102
| Link | `discord.ButtonStyle.link` / `discord.ButtonStyle.url` | Grey |
103103

104-
Check out the [`discord.ButtonStyle`](https://docs.pycord.dev/en/stable/api.html#discord.ButtonStyle) class for more information.
104+
Check out the [`discord.ButtonStyle`](https://docs.pycord.dev/en/stable/api/enums.html#discord.ButtonStyle) class for more information.
105105

106106
![Different Button Styles](../../assets/interactions/button-styles.png)
107107

108-
You can set a button's style by adding the `style` argument in the [`discord.ui.button`](https://docs.pycord.dev/en/stable/api.html#discord.ui.button) decorator.
108+
You can set a button's style by adding the `style` argument in the [`discord.ui.button`](https://docs.pycord.dev/en/stable/api/ui_kit.html#discord.ui.button) decorator.
109109

110110
```python
111111
class MyView(discord.ui.View):
@@ -119,7 +119,7 @@ class MyView(discord.ui.View):
119119
We have discussed that Views can have 5 rows. Each row has 5 slots, and each button takes up 1 slot.
120120
So, how do we move the buttons to another row?
121121

122-
This can be done by specifying the `row` argument in the [`discord.ui.button`](https://docs.pycord.dev/en/stable/api.html#discord.ui.button)
122+
This can be done by specifying the `row` argument in the [`discord.ui.button`](https://docs.pycord.dev/en/stable/api/ui_kit.html#discord.ui.button)
123123
decorator.
124124

125125
:::info The `row` argument

0 commit comments

Comments
 (0)