-
Notifications
You must be signed in to change notification settings - Fork 789
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Grammatically updated the DiscordGo docs #979
base: master
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The commit message is misspelled, too. 😛
README.md
Outdated
@@ -18,7 +17,7 @@ indispensable help to this project. | |||
additional voice helper functions and features for DiscordGo. | |||
|
|||
* See [dca](https://github.com/bwmarrin/dca) for an **experimental** stand alone | |||
tool that wraps `ffmpeg` to create opus encoded audio appropriate for use with | |||
tool that wraps `FFmpeg to create opus encoded audio appropriately for use with |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
appropriate
is correct. It's modifying audio
, not create
. It's an adjective, not an adverb.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
appropriate
is correct. It's modifyingaudio
, notcreate
. It's an adjective, not an adverb.
I ran this through my head a couple of times, but you're definitely correct here. Good catch 👍
README.md
Outdated
@@ -84,14 +83,13 @@ section of the project wiki. | |||
|
|||
|
|||
## Contributing | |||
Contributions are very welcomed, however please follow the below guidelines. | |||
Contributions are very welcomed, however, please follow the below guidelines. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Re-wording this sentence completely might be an option, but as it stands, the comma doesn't belong here. "however" is modifying the latter half of the sentence, not the former.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh, nice catch again Carson. You're correct about the comma. I looked over this sentence rather quickly but I should have double-checked it.
README.md
Outdated
@@ -18,7 +17,7 @@ indispensable help to this project. | |||
additional voice helper functions and features for DiscordGo. | |||
|
|||
* See [dca](https://github.com/bwmarrin/dca) for an **experimental** stand alone | |||
tool that wraps `ffmpeg` to create opus encoded audio appropriate for use with | |||
tool that wraps `FFmpeg to create opus encoded audio appropriately for use with |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It seems like you dropped the closing code tick here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good catch.
docs/GettingStarted.md
Outdated
@@ -52,8 +44,8 @@ for your editor — they are hugely helpful when developing Go code. | |||
|
|||
# Install DiscordGo | |||
|
|||
Like any other Go package the fist step is to `go get` the package. This will | |||
always pull the latest tagged release from the master branch. Then run | |||
Like any other Go package, the first step is to `go get the package. This will |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It again seems like you dropped the closing code tick.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good catch.
haha, good catch! appreciate the thorough review, definitely wouldn't want to add any new issues c: I went ahead and revised the issues you pointed out in the latest commit. Best Regards, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi. Sorry review took a long time.
Overall PR looks good to me. But since this PR corrects not only grammar, but also spacing, I think it would be fair to fix all double spaces the docs have.
Also, please note the conflicts.
recommend you walk though [A Tour of Go](https://tour.golang.org/welcome/1) to | ||
help get your familiar with the Go language. Also checkout the relevent Go plugin | ||
for your editor — they are hugely helpful when developing Go code. | ||
You must already have a working Go environment set up to use DiscordGo. If you are new to Go and have not yet installed and tested it on your computer then please visit [this page](https://golang.org/doc/install) first then I highly |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You must already have a working Go environment set up to use DiscordGo. If you are new to Go and have not yet installed and tested it on your computer then please visit [this page](https://golang.org/doc/install) first then I highly | |
You must already have a working Go environment set up to use DiscordGo. If you are new to Go and have not yet installed and tested it on your computer then please visit [this page](https://golang.org/doc/install) first, then I highly |
This example uses bot tokens for authentication only. While email/password is | ||
supported by DiscordGo, it is not recommended to use them. | ||
supported by DiscordGo, their use is not recommended. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
DiscordGo dropped all user account endpoints, I think would be better to remove this line.
05d8167
to
d7b4a48
Compare
Changes
Cleaned up grammatical issues found within DiscordGo's different .md files