Skip to content

Commit 1232979

Browse files
authored
Change docs links to stable, master docs are changed
1 parent 3429d97 commit 1232979

File tree

13 files changed

+58
-58
lines changed

13 files changed

+58
-58
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/master/api.html#discord.ext.commands.DefaultHelpCommand)
58-
- [`MinimalHelpCommand`](https://docs.pycord.dev/en/master/api.html#discord.ext.commands.MinimalHelpCommand)
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)
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/extensions/pages/paginator-basics.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Paginator Basics
44

55
# Paginator Basics
66

7-
## [Page](https://docs.pycord.dev/en/master/ext/pages/index.html#page)
7+
## [Page](https://docs.pycord.dev/en/stable/ext/pages/index.html#page)
88
This class contains two attributes: `content` and `embeds`, which correspond to the attributes of the same name on the
99
`discord.Message` class.
1010
To create a new Page, use the following syntax:
@@ -13,11 +13,11 @@ import discord
1313
page = Page(content="My Page Content", embeds=[discord.Embed(title="My First Embed Title")])
1414
```
1515

16-
## [PageGroup](https://docs.pycord.dev/en/master/ext/pages/index.html#pagegroup)
16+
## [PageGroup](https://docs.pycord.dev/en/stable/ext/pages/index.html#pagegroup)
1717
This class represents a group of pages. It uses most of the same parameters as `Paginator`, which allows each
1818
`PageGroup` to effectively have its own settings and behaviours.
1919

20-
## [Paginator](https://docs.pycord.dev/en/master/ext/pages/index.html#paginator)
20+
## [Paginator](https://docs.pycord.dev/en/stable/ext/pages/index.html#paginator)
2121
This is the main class for `ext.pages`, and is used to control most of the functionality of the extension.
2222

2323
In its most basic form, with no arguments provided (default values listed below), a paginator can be created like so:
@@ -54,8 +54,8 @@ The only required parameter for `Paginator` is the `pages` parameter, which is u
5454
You can also pass in a list of `PageGroup` objects, a list of strings, a list of embeds, or a list of lists of embeds.
5555

5656
Once the `Paginator` instance is created, you can call either
57-
[`Paginator.send()`](https://docs.pycord.dev/en/master/ext/pages/index.html#discord.ext.pages.Paginator.send)
58-
or [`Paginator.respond()`](https://docs.pycord.dev/en/master/ext/pages/index.html#discord.ext.pages.Paginator.respond)
57+
[`Paginator.send()`](https://docs.pycord.dev/en/stable/ext/pages/index.html#discord.ext.pages.Paginator.send)
58+
or [`Paginator.respond()`](https://docs.pycord.dev/en/stable/ext/pages/index.html#discord.ext.pages.Paginator.respond)
5959
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:
@@ -89,11 +89,11 @@ child list. This type of page cannot have any message content.
8989
- 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
92-
[API Reference](https://docs.pycord.dev/en/master/ext/pages/index.html#paginator)**
92+
[API Reference](https://docs.pycord.dev/en/stable/ext/pages/index.html#paginator)**
9393

9494

9595

96-
## [PaginatorButton](https://docs.pycord.dev/en/master/ext/pages/index.html#paginatorbutton)
96+
## [PaginatorButton](https://docs.pycord.dev/en/stable/ext/pages/index.html#paginatorbutton)
9797
This class represents a button used to navigate between the pages of a paginator. It's also used to create the page
9898
indicator.
9999

@@ -143,7 +143,7 @@ paginator.remove_button("last")
143143
```
144144

145145

146-
## [PaginatorMenu](https://docs.pycord.dev/en/master/ext/pages/index.html#paginatormenu)
146+
## [PaginatorMenu](https://docs.pycord.dev/en/stable/ext/pages/index.html#paginatormenu)
147147
This class represents the `discord.Select` menu used to navigate between `PageGroup` instances. In most situations, you
148148
will not need to interact with this class directly.
149149

docs/extensions/tasks/tasks.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ doing very useful stuff.
3535
doing very useful stuff.
3636
```
3737

38-
For a more useful example here's a task in a cog context ripped straight from the [docs](https://docs.pycord.dev/en/master/ext/tasks/index.html#recepies):
38+
For a more useful example here's a task in a cog context ripped straight from the [docs](https://docs.pycord.dev/en/stable/ext/tasks/index.html#recepies):
3939

4040
```py
4141
from discord.ext import tasks, commands
@@ -64,13 +64,13 @@ As you'd expect this will increment a number and print it out every 5 seconds li
6464
# ...
6565
```
6666

67-
## [Tasks](https://docs.pycord.dev/en/master/ext/tasks/index.html)
67+
## [Tasks](https://docs.pycord.dev/en/stable/ext/tasks/index.html)
6868

6969
Now let's get into the nitty-gritty of tasks.
7070

7171
As you've seen tasks can work in both outer scope and class contexts and the handle is roughly the same, you define a task using the `tasks.loop` decorator and use the `start` method to start it, the difference is you add the `self` argument when in a class context so since most people have all their bot's code in Cogs all the following code blocks will be in a Cog context to make it easy to copy it then apply whatever modifications you might need!
7272

73-
### [Creating a task](https://docs.pycord.dev/en/master/ext/tasks/index.html#discord.ext.tasks.loop)
73+
### [Creating a task](https://docs.pycord.dev/en/stable/ext/tasks/index.html#discord.ext.tasks.loop)
7474

7575
A look at `discord.ext.tasks.loop`'s definition in the documentation reveals that:
7676
1. As you've seen before it expects the time between each execution, that however doesn't have to be in seconds as
@@ -83,7 +83,7 @@ to make it run forever which is also the default.
8383
4. The loop function ***must*** be a coroutine.
8484

8585
These are all really useful, and they aren't the only parameters so if you want to know more about them check out the
86-
[docs](https://docs.pycord.dev/en/master/ext/tasks/index.html#discord.ext.tasks.loop)!
86+
[docs](https://docs.pycord.dev/en/stable/ext/tasks/index.html#discord.ext.tasks.loop)!
8787

8888
### Attributes
8989

@@ -208,5 +208,5 @@ the `stop` method and `restart` which restarts the task using the `restart` meth
208208
Finally, we add the `LeaderboardCog` cog to the bot, and we're done!
209209

210210
I'd highly recommend you check the tasks extension
211-
[documentation](https://docs.pycord.dev/en/master/ext/tasks/index.html) for more info on how to use them and what other
211+
[documentation](https://docs.pycord.dev/en/stable/ext/tasks/index.html) for more info on how to use them and what other
212212
functions they have.

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ 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/master/api.html#discord.Bot).
176+
In this line, we create a new instance of [`discord.Bot`](https://docs.pycord.dev/en/stable/api.html#discord.Bot).
177177
In this object, we can pass various parameters for configuration purposes, such as `owner_ids`
178178
and [`intents`](https://docs.pycord.dev/en/stable/api.html?highlight=get_message#discord.Intents).
179179

@@ -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/master/api.html#discord.Bot.event) decorator to override
189-
the [`on_ready`](https://docs.pycord.dev/en/master/api.html#discord.on_ready) function to define an
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
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/master/api.html#discord.Bot.slash_command)
198+
Here, we use the [`slash_command`](https://docs.pycord.dev/en/stable/api.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: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ First, you need to ask Discord to send you events. This is done via "Intents". R
2727

2828
Once you understand what intents are, you can enable the events you need, or just use the default ones with `discord.Intents.all()`.
2929

30-
Now that that's done, let's add an event handler for when a user joins the server. We will use the [`on_member_join` event](https://docs.pycord.dev/en/master/api.html#discord.on_member_join). We will send a private message to the user welcoming them to the server.
30+
Now that that's done, let's add an event handler for when a user joins the server. We will use the [`on_member_join` event](https://docs.pycord.dev/en/stable/api.html#discord.on_member_join). We will send a private message to the user welcoming them to the server.
3131

3232
```python
3333
@bot.event
@@ -37,15 +37,15 @@ async def on_member_join(member):
3737
)
3838
```
3939

40-
We use the [`discord.Bot.event` decorator](https://docs.pycord.dev/en/master/api.html#discord.Bot.event) to add the event handler.
40+
We use the [`discord.Bot.event` decorator](https://docs.pycord.dev/en/stable/api.html#discord.Bot.event) to add the event handler.
4141

42-
The `on_member_join` event is called when a user joins the server. The `member` parameter is the user that joined. Different events have different names and parameters. You can find all of them [here](https://docs.pycord.dev/en/master/api.html#discord.Intents).
42+
The `on_member_join` event is called when a user joins the server. The `member` parameter is the user that joined. Different events have different names and parameters. You can find all of them [here](https://docs.pycord.dev/en/stable/api.html#discord.Intents).
4343

4444
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/master/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.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/master/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.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/master/api.html#discord.Embed)
190+
This command creates an embed. We use the [`Embed`](https://docs.pycord.dev/en/stable/api.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/master/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.html#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/master/api.html#discord.Embed.add_field)
205-
of the [`discord.Embed`](https://docs.pycord.dev/en/master/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.html#discord.Embed.add_field)
205+
of the [`discord.Embed`](https://docs.pycord.dev/en/stable/api.html#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/master/api.html#discord.Embed.set_footer)
216+
- Footer - With the [`set_footer()`](https://docs.pycord.dev/en/stable/api.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/master/api.html#discord.Embed.set_author)
218+
- Author - With the [`set_author`](https://docs.pycord.dev/en/stable/api.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/master/api.html#discord.Embed.set_thumbnail)
221+
- Thumbnail - With the [`set_thumbnail`](https://docs.pycord.dev/en/stable/api.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/master/api.html#discord.Embed.set_image)
223+
- Image - With the [`set_image`](https://docs.pycord.dev/en/stable/api.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/master/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.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/master/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.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/master/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.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/master/api.html#discord.SlashCommandOptionType) enum.
182+
You could also explicitly declare the type using the [`SlashCommandOptionType`](https://docs.pycord.dev/en/stable/api.html#discord.SlashCommandOptionType) enum.
183183

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

0 commit comments

Comments
 (0)