Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Grammatically updated the DiscordGo docs #979

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Grammatically updated the DiscordGo docs #979

wants to merge 2 commits into from

Conversation

JCorcho
Copy link

@JCorcho JCorcho commented Jul 29, 2021

Changes

Cleaned up grammatical issues found within DiscordGo's different .md files

@JCorcho JCorcho mentioned this pull request Jul 29, 2021
Open
CarsonHoffman
CarsonHoffman requested changes Jul 29, 2021
View reviewed changes
Copy link
Collaborator

@CarsonHoffman CarsonHoffman left a 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
Copy link
Collaborator

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.

Copy link
Author

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.
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.
Copy link
Collaborator

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.

Copy link
Author

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
Copy link
Collaborator

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.

Copy link
Author

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
Copy link
Collaborator

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.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch.

@JCorcho
Copy link
Author

JCorcho commented Jul 29, 2021

The commit message is misspelled, too. 😛

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,
JC

FedorLap2006
FedorLap2006 requested changes Mar 24, 2022
View reviewed changes
Copy link
Collaborator

@FedorLap2006 FedorLap2006 left a 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.

docs/GettingStarted.md
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
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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

examples/avatar/README.md
Comment on lines 26 to +27
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.
Copy link
Collaborator

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.

@FedorLap2006 FedorLap2006 linked an issue Mar 24, 2022 that may be closed by this pull request
README files grammatical issues. #980
Open
@FedorLap2006 FedorLap2006 force-pushed the master branch 2 times, most recently from 05d8167 to d7b4a48 Compare May 22, 2022 22:16
@FedorLap2006 FedorLap2006 added the semver ignore Ignore in the release notes label Jun 11, 2022
@FedorLap2006 FedorLap2006 added the meta Documentation and examples related issues and pull requests label Oct 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@FedorLap2006 FedorLap2006 FedorLap2006 requested changes

@CarsonHoffman CarsonHoffman Awaiting requested review from CarsonHoffman

Assignees
No one assigned
Labels
meta Documentation and examples related issues and pull requests semver ignore Ignore in the release notes
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

README files grammatical issues.
3 participants
@JCorcho @CarsonHoffman @FedorLap2006