Skip to content

Commit 8f4ab4c

Browse files
authored
Merge pull request #247 from BPS-Circular-API/main
Fix minor grammatical errors within the docs
2 parents c899d45 + 2f9a23b commit 8f4ab4c

File tree

19 files changed

+44
-44
lines changed

19 files changed

+44
-44
lines changed

docs/extensions/commands/help-command.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -359,7 +359,7 @@ class MyHelp(commands.HelpCommand):
359359
await self.get_destination().send(embed=embed)
360360
```
361361

362-
Add all of these methods together and you have a fully functioning help command!
362+
Add all of these methods together, and you have a fully functioning help command!
363363

364364
<details>
365365
<summary>Click to see the final code for this section</summary>

docs/extensions/tasks/tasks.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ at the specified time(s).
8282
to make it run forever which is also the default.
8383
4. The loop function ***must*** be a coroutine.
8484

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

8888
### Attributes
@@ -103,7 +103,7 @@ Now let's create a cog that handles a leaderboard we have in our bot using Tasks
103103
also provide a refresher of how slash commands groups work in cogs.
104104

105105
For the sake of this example let's pretend that we have a leaderboard module that does all the leaderboard handling for
106-
us and that computing the leaderboard is very expensive computationally wise so we want to store one version of it that
106+
us and that computing the leaderboard is very expensive computationally wise, so we want to store one version of it that
107107
gets regularly updated instead of generating it every time someone calls the `/leaderboard view` command.
108108
```py
109109
from discord.ext import tasks, commands
@@ -183,29 +183,29 @@ Now to explain what's going on:
183183
First things first we create a cog and in its `__init__` function we start the `update_leaderboard` task and generate
184184
the first instance of our leaderboard's embed.
185185

186-
After that, we define the `update_leaderboard` task using the `loop` decorator and we make it run every ten minutes by
186+
After that, we define the `update_leaderboard` task using the `loop` decorator, and we make it run every ten minutes by
187187
passing 10 to the `minutes` parameter.
188188

189-
Then that we define the `before_update_leaderboard` task using the `before_loop` decorator and we make it wait until the
189+
Then that we define the `before_update_leaderboard` task using the `before_loop` decorator, and we make it wait until the
190190
bot is ready before starting the task.
191191

192-
Next up we define the `after_update_leaderboard` task using the `after_loop` decorator and we make it clean up the
192+
Next up we define the `after_update_leaderboard` task using the `after_loop` decorator, and we make it clean up the
193193
leaderboard when the loop finally stops running.
194194

195-
Then we define the `update_leaderboard_error` task using the `error` decorator and we make it print any errors that may
195+
Then we define the `update_leaderboard_error` task using the `error` decorator, and we make it print any errors that may
196196
occur while we update our leaderboard to the console.
197197

198198
Then we get into the fun stuff, we create a slash command group using the `SlashCommandGroup` class and name it
199199
`leaderboard`, we then create the `view` sub-command which sends the embed generated when the leaderboard is updated and
200-
`update_info` which shows a lot of data about the task using some of the attributes and functions available to us.
200+
`update_info` which shows a lot of data about the task using some attributes and functions available to us.
201201

202202
We also create a slash command group called `leaderboard_config` which is only available to the owner of the bot.
203203

204204
Then we create the `set_time_between_updates` sub-command which takes in the time in minutes and changes the time
205205
between updates of the leaderboard using the `change_interval` method, the `stop` sub-command which stops the task using
206206
the `stop` method and `restart` which restarts the task using the `restart` method.
207207

208-
Finally, we add the `LeaderboardCog` cog to the bot and we're done!
208+
Finally, we add the `LeaderboardCog` cog to the bot, and we're done!
209209

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

docs/getting-started/more-features.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ So, you just created your first Pycord bot! Now, let's add some more features to
2121

2222
### Event Handlers
2323

24-
Events in Discord are a way to listen for certain actions. For example, if you want to know when a user joins your server so you could send a welcome message, you can use the `on_member_join` event.
24+
Events in Discord are a way to listen for certain actions. For example, if you want to know when a user joins your server, so you could send a welcome message, you can use the `on_member_join` event.
2525

2626
First, you need to ask Discord to send you events. This is done via "Intents". Read up the [Intents](../Popular-Topics/intents) page for more information.
2727

@@ -203,7 +203,7 @@ embed.add_field(title="Inline Field 3", value="Inline Field 3", inline=True)
203203

204204
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)
205205
of the [`discord.Embed`](https://docs.pycord.dev/en/master/api.html#embed) class. These consist of three
206-
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 or not space will be divided among the inline fields. There could be a mix of fields where inline has different values too.
206+
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
209209
embed.set_footer(text="Footer! No markdown here.") # footers can have icons too
@@ -324,7 +324,7 @@ by using the following syntax:
324324
Inside the supported elements that have just been mentioned,
325325
the example above will look like this: [`Pycord`](https://pycord.dev/)
326326

327-
Outside of them, the link will still be clickable but the formatting will be ignored,
327+
Outside them, the link will still be clickable but the formatting will be ignored,
328328
therefore the example above will look similarly to this: `[Pycord](https://pycord.dev/)`
329329

330330
#### Embed Markdown

docs/getting-started/rules-and-common-practices.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ about it. I'm here to tell you that it isn't a good idea to shard your bot.
5959
*Wait a minute, why would it be an option if it wasn't a good idea?* It's simple. I lied. Sort of.
6060
I'm not going to go into the details of sharding a bot, so you can read about it on
6161
[this page](../Popular-Topics/sharding). Sharding is the process of taking your bot
62-
and breaking it up into small pieces so it's easier to perform tasks. This is very useful for large
62+
and breaking it up into small pieces, so it's easier to perform tasks. This is very useful for large
6363
bots, as it makes them faster and more reliable. Sharding is not a good practice for small bots.
6464

6565
:::note
@@ -84,7 +84,7 @@ will be denied simply because you applied for an intent you didn't need.
8484
### Subclassing
8585

8686
While it may take some time, subclassing a bot is very worth it. Once again, this was explained
87-
elsewhere so I won't go into the details, but I felt it fit here so I put it here.
87+
elsewhere, so I won't go into the details, but I felt it fit here, so I put it here.
8888

8989
Subclassing a bot makes it more flexible and allows it to do a lot more. Read more about subclassing
9090
bots [here](../Popular-Topics/subclassing-bots)
@@ -96,7 +96,7 @@ Your bot is only able to be run for one reason: its token. If you followed the
9696
keeping that token safe. That's exactly what you want to do.
9797

9898
Sharing your token is never good. If someone evil gets a hold of your token, they can do terrible things,
99-
such as making your bot leave all of its servers, spamming all of the members the bot has contact with,
99+
such as making your bot leave all of its servers, spamming all the members the bot has contact with,
100100
and even manipulating the servers the bot is in, if given the permissions. That's why it's very important
101101
to keep your token safe. To learn how to do so, read [this part](creating-your-first-bot#tokens) of
102102
the Creating Your First Bot guide.
@@ -106,13 +106,13 @@ the Creating Your First Bot guide.
106106
You always want to back up your bot's data. This includes both its code *and* its databases. This way,
107107
if something tragic happens, such as your host failing a data migration or you breaking your Raspberry
108108
Pi's SD card that held your bot, you'll still have its precious user data. I have a small program for
109-
my bot that uploads its databases to a remote GitHub repository every now and then to not lose any data.
109+
my bot that uploads its databases to a remote GitHub repository periodically to not lose any data.
110110
It may be smarter to find a bit more of a reliable way to do so, though.
111111

112112
Public or private, having a local Git repository connected to a remote one is a good idea for making
113113
almost any application. For a lot of developers, it's like saving your work. If you do this, all of
114-
your bot's code won't be lost if your computer spontaneously combusts or you smash it to bits from
115-
anger. You can simply grab the backup computer that everyone has laying around and you're back
114+
your bot's code won't be lost if your computer spontaneously combusts, or you smash it to bits from
115+
anger. You can simply grab the backup computer that everyone has lying around, and you're back
116116
in business.
117117

118118
### Organization and Cleanliness
@@ -165,7 +165,7 @@ MongoDB is a JSON-like format and if you already use JSON files, it shouldn't be
165165

166166
#### SQLite
167167
SQLite is based on SQL, a common relational data model. It's a lightweight, easy-to-use, portable database solution that
168-
works entirely on files. However, if for some reason you cannot read/write to and from a file and you need to manage
168+
works entirely on files. However, if for some reason you cannot read/write to and from a file, and you need to manage
169169
lots of data, SQLite might not be for you.
170170

171171
While SQLite is a part of the Python Standard Library as the `sqlite3` package, we recommend not using it as it is

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@ import "discord-message-components/packages/react/dist/style.css";
1414

1515
import DiscordComponent, { defaultOptions } from "../../../src/components/DiscordComponent";
1616

17-
When you right-click a message, you may see an option called "Apps". Hover over it and you can see
17+
When you right-click a message, you may see an option called "Apps". Hover over it, and you can see
1818
commands a bot can run with that message. These are called message commands.
1919

2020
When you right-click a user in the user list, you can once again see an option called "Apps".
21-
Hover over it and you can see commands a bot can run with that message. These are called user commands.
21+
Hover over it, and you can see commands a bot can run with that message. These are called user commands.
2222

2323
Together, these two are called Context Menus or Context Menu Commands. These commands work very much like normal commands, except they take a member or message.
2424

docs/interactions/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import DiscordComponent, { defaultOptions } from "../../src/components/DiscordCo
1515

1616
In December 2020, Discord released their first Interaction: the
1717
[Slash Command](https://discord.com/developers/docs/interactions/application-commands#slash-commands).
18-
Since then, Discord has added many different types of Interactions, including:
18+
Since then, Discord has added many types of Interactions, including:
1919

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

@@ -233,7 +233,7 @@ Menus page](./ui-components/dropdowns.mdx).
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,
236-
which avoids having the user send multiple messages for the bot. Modals can accessed by either invoking an Application Command or by
236+
which avoids having the user send multiple messages for the bot. Modals can be accessed by either invoking an Application Command or by
237237
interacting with another UI Component.
238238

239239
![Text Modal Example Image](../assets/interactions/modal-example.png)

docs/interactions/ui-components/buttons.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,7 @@ No. As a Discord limitation, you can only have one view per message.
288288

289289
They cannot be simple like commands. This system makes them flexible and doesn't limit your imagination. There are loads of different ways you can use UI Components. For example, you could subclass Buttons or Select Menus and add them to a view using the view's `add_item` function.
290290

291-
UI Components aren't hard to use if you know Python. We recommend learning [Object Oriented Programming with Python](#oop).
291+
UI Components aren't hard to use if you know Python. We recommend learning [Object-Oriented Programming with Python](#oop).
292292

293293
#### <span id="oop">What is OOP? What is subclassing?</span>
294294

docs/interactions/ui-components/dropdowns.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ That was the decorator. Now, the function itself is pretty simple. It takes two
6969

7070
<!-- TODO: The values are sorted in the order the user selected them (?). The selected values are (?) -->
7171

72-
In the callback, you could do anything you want. You get the two parameters `select` and `interaction` to play around with. Here, we send a message using `await interaction.response.send_message` (where interaction is [`discord.InteractionResponse`](https://docs.pycord.dev/en/master/api.html#discord.InteractionResponse)) with content `select.values[0]`, which sends the label of the first/only option the user selected. Obviously, this is only an example and you could do just about anything you want.
72+
In the callback, you could do anything you want. You get the two parameters `select` and `interaction` to play around with. Here, we send a message using `await interaction.response.send_message` (where interaction is [`discord.InteractionResponse`](https://docs.pycord.dev/en/master/api.html#discord.InteractionResponse)) with content `select.values[0]`, which sends the label of the first/only option the user selected. Obviously, this is only an example, and you could do just about anything you want.
7373

7474
Finally, we create a global slash command called `flavour` that sends a message "Choose a flavor!" along with the view
7575
that contains our select menu.
@@ -281,7 +281,7 @@ No. As a Discord limitation, you can only have one view per message.
281281

282282
They cannot be simple like commands. This system makes them flexible and doesn't limit your imagination. There are loads of different ways you can use UI Components. For example, you could subclass Buttons or Select Menus and add them to a view using the view's `add_item` function.
283283

284-
UI Components aren't hard to use if you know Python. We recommend learning [Object Oriented Programming with Python](#oop).
284+
UI Components aren't hard to use if you know Python. We recommend learning [Object-Oriented Programming with Python](#oop).
285285

286286
#### <e id="oop">What is OOP? What is subclassing?</e>
287287

docs/introduction.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Here are some good resources to get started or to freshen up your Python knowled
4141

4242
First of all, we would like to thank [Rapptz](https://github.com/Rapptz) for the original [discord.py](https://pypi.org/project/discord.py) library. Pycord is a maintained fork of this library.
4343

44-
We would also like to thank the [discord.js guide](https://discordjs.guide), which inspired this guide style-wise, and the [original Pycord Guide](https://namantech.me/pycord), which inspired some of the content in this guide.
44+
We would also like to thank the [discord.js guide](https://discordjs.guide), which inspired this guide style-wise, and the [original Pycord Guide](https://namantech.me/pycord), which inspired some content in this guide.
4545

4646
We created this guide using [Docusaurus v2](https://docusaurus.io), a modern static site generator for React. We would also like to thank Danktuary for his [`@discord-message-components/react`](https://www.npmjs.com/package/@discord-message-components/react) package, from which we took the Discord message components.
4747

docs/more/contributing.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ This page outlines some of the basic syntax you need to know to contribute to th
2121

2222
## Info
2323

24-
We use [Docusaurus v2](https://docusaurus.io/) to generate our guide. All of the guide pages are generated
24+
We use [Docusaurus v2](https://docusaurus.io/) to generate our guide. All the guide pages are generated
2525
from `mdx` files in the [`docs/`](https://github.com/Pycord-Development/guide/tree/master/docs) directory.
2626
MDX allows you to use JSX in your markdown content.
2727

0 commit comments

Comments
 (0)