Skip to content

Commit e40665f

Browse files
authored
Merge pull request #90 from naem-less/main
spelling/grammar update along with some other misc updates
2 parents 90a78e3 + 05a7a21 commit e40665f

125 files changed

Lines changed: 490 additions & 455 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

guide/Bot/botCount.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Returns the amount of bots in your server/guild!
1313
</discord-messages>
1414

1515
::: danger Warning
16-
This data comes from the cache, not the api, therefore it may not be precise unless all the guild members are cached (which only in tier 5).
16+
This data comes from the cache, not the api, therefore it may not be precise unless all the guild members are cached (which is only in tier 5).
1717
:::
1818

1919
##### Function Difficulty: <Badge type="tip" text="Easy" vertical="middle" />

guide/Bot/botOwnerID.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# $botOwnerID
22

33
Returns the ID of the bot owner.
4-
If the bot belongs to a team, it'll return multiple ID.
5-
Optionally, and if there is more than one owner (team), you can input a separator.
4+
If the bot belongs to a team, it'll return multiple IDs.
5+
Optionally, if there is more than one owner (team) you can input a separator.
66

77
## Usage
88

guide/Bot/ping.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ This function returns the bot's ping, it can be used to check if the bot is onli
55
<br/>
66
<discord-messages>
77
<discord-message :bot="false" role-color="#ffcc9a" author="Member">
8-
!!exec `$ping`ms
8+
!!exec $ping ms
99
</discord-message>
1010
<discord-message :bot="true" role-color="#0099ff" author="Custom Command" avatar="https://media.discordapp.net/avatars/725721249652670555/781224f90c3b841ba5b40678e032f74a.webp">
11-
`20`ms
11+
20 ms
1212
</discord-message>
1313
</discord-messages>
1414

guide/Bot/serverCount.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ Returns the amount of servers the bot is in.
55
<br/>
66
<discord-messages>
77
<discord-message :bot="false" role-color="#ffcc9a" author="Member">
8-
!!exec I am in `$serverCount` servers.
8+
!!exec I am in $serverCount servers.
99
</discord-message>
1010
<discord-message :bot="true" role-color="#0099ff" author="Custom Command" avatar="https://media.discordapp.net/avatars/725721249652670555/781224f90c3b841ba5b40678e032f74a.webp">
11-
I am in `15000` servers.
11+
I am in 15000 servers.
1212
</discord-message>
1313
</discord-messages>
1414

guide/Channel/vcAfter.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# $vcAfter
22

3-
Returns the Voice channelID that the user switched to, **after**.
3+
Returns the Voice channelID that the user switched to, **after** switching voice channels or joining a voice channel without being in one prior.
44

55
## Usage
66

guide/Channel/vcBefore.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# $vcBefore
22

3-
Returns the Voice channelID the user switched from.
3+
Returns the Voice channelID the user switched from when switching voice channels or when a user leaves a voice channel.
44

55
## Usage
66

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Message types
2+
Use the `$messageType` function to return the type of the message.
3+
4+
### Current message types:
5+
```
6+
Default
7+
Recipient Add
8+
Recipient Remove
9+
Call
10+
Channel Name Change
11+
Channel Icon Change
12+
Channel Pinned Message
13+
User Join
14+
Guild Boost
15+
Guild Boost Tier 1
16+
Guild Boost Tier 2
17+
Guild Boost Tier 3
18+
Channel Follow Add
19+
Guild Discovery Disqualified
20+
Guild Discovery Requalified
21+
Guild Discovery Grace Period Initial Warning
22+
Guild Discovery Grace Period Final Warning
23+
Thread Created
24+
Reply
25+
Chat Input Command
26+
Thread Starter Message
27+
Guild Invite Reminder
28+
Context Menu Command
29+
Auto Moderation Action
30+
Role Subscription Purchase
31+
Interaction Premium Upsell
32+
Stage Start
33+
Stage End
34+
Stage Speaker
35+
Stage Topic
36+
Guild Application Premium Subscription
37+
Guild Incident Alert Mode Enabled
38+
Guild Incident Alert Mode Disabled
39+
Guild Incident Report Raid
40+
Guild Incident Report False Alarm
41+
Purchase Notification
42+
```

guide/Contribution_Info/main.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
11
# Main Information
22

33
## Rules
4-
Please follow the following rules:
4+
Please follow the contribution rules:
55

66
* Use the template for every function. Template can be found [here](./function_template.md)
77
* Please use correct English sentences. Swearing is forbidden
8-
* Make clear what you have changed when you make an pull request. Use an appropriate title & description
9-
* Make sure you make docs on functions you know well. You should prevent, in any way possible, that wrong information is pushed.
8+
* Make clear what you have changed when you make a pull request. Use an appropriate title & description
9+
* Make sure you make docs on functions you know well. You should avoid, in any way possible, that wrong information is pushed.
1010

1111
### Editing existing or adding docs
1212
You can edit pages in our github repo. You can click the edit page button for existing page.
1313

1414
#### Requirements
1515
* Github [account](https://github.com)
16-
* Never used Github? Check this https://docs.github.com/en
16+
* Never used Github? Check the github [docs](https://docs.github.com/en)
1717
* Basic knowledge of [markdown]( https://www.markdownguide.org/cheat-sheet/)
1818

1919
Since the function doesn't exist,you have to create a file inside the specific folder in the [repo](https://github.com/raspdevpy/ccdoc/tree/main/guide)
2020
Example $botCount
2121

2222
0. Check in `undone.md` to be sure,that nobody else already documented the function.
23-
1. Fork the [repo](https://github.com/raspdevpy/ccdoc/tree/
23+
1. Fork the [repo](https://github.com/raspdevpy/ccdoc/tree/)
2424
![](https://i.ibb.co/2kPRCX0/image.png)
2525
2. Create a file in bot folder with name `botCount.md`
2626
![](https://i.ibb.co/BLCbs7q/image.png)
@@ -30,8 +30,8 @@ Example $botCount
3030
![](https://i.ibb.co/8XvCCdm/image.png)
3131
5. go to undone.md and move the function to done
3232
![](https://i.ibb.co/85PxQjM/image.png)
33-
5. If you have done all your changes(add many function docs,not only 1 change), do a pull request,which we will review.
33+
5. If you have done all your changes(add/change many function docs,not only 1), do a pull request,which we will review.
3434
![](https://i.ibb.co/p3RCGYf/image.png)
3535
![](https://i.ibb.co/R9fJz7g/image.png)
3636

37-
### For extra information, please contact a moderator/ developer in our discord server!
37+
### For extra information, please contact a moderator/developer in our discord server!

guide/Date/formatDate.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# $formatDate
2-
Formats the providen Date in Milliseconds / Stringed Date / ISO String to default/given format. syntax of formats can be found (here)[https://momentjs.com/docs/#/parsing/string-format/]
2+
Formats the providen Date provided in Milliseconds/Stringed Date/ISO String to default/given format. Syntax of formats can be found [here](https://momentjs.com/docs/#/parsing/string-format/)
33
#### Usage: `$formatDate[date in ms / string / iso string / javascript convertable date;format]`
44
Example:
55
<br/>
@@ -39,4 +39,4 @@ Date functions uses on default UTC timezone,but you can change it [Learn More](.
3939
:::
4040

4141
##### Function difficulty: <Badge type="tip" text="Easy" vertical="middle" />
42-
###### Tags: <Badge type="tip" text="formatDate" vertical="middle" />
42+
###### Tags: <Badge type="tip" text="formatDate" vertical="middle" />

guide/Date/humanizeMS.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# $humanizeMS
2-
Converts Milliseconds into a Readable durations
2+
Converts milliseconds into human readable durations
33

44
#### Usage: `$humanizeMS[MS;limit (Number) (optional), separator (optional)]`
55
Example:
@@ -13,9 +13,9 @@ Example:
1313
</discord-message>
1414
</discord-messages>
1515

16-
::: tip Other Timezone
17-
Date functions uses on default UTC timezone,but you can change it [Learn More](./timezone.md)
16+
::: tip Other Timezones
17+
Date functions by default use the UTC timezone,but you can change it [Learn More](./timezone.md)
1818
:::
1919

2020
##### Function difficulty: <Badge type="tip" text="Easy" vertical="middle" />
21-
###### Tags: <Badge type="tip" text="humanizeMS" vertical="middle" />
21+
###### Tags: <Badge type="tip" text="humanizeMS" vertical="middle" />

0 commit comments

Comments
 (0)