Skip to content

chore: fix spelling typos - #650

Merged
childish-sambino merged 13 commits into
sendgrid:mainfrom
jsoref:spelling
Oct 14, 2020
Merged

chore: fix spelling typos#650
childish-sambino merged 13 commits into
sendgrid:mainfrom
jsoref:spelling

Conversation

@jsoref

@jsoref jsoref commented Oct 14, 2020

Copy link
Copy Markdown
Contributor

Fixes

This PR corrects misspellings identified by the check-spelling action.

The misspellings have been reported at jsoref@7a7f4d9#commitcomment-43247897

The action reports that the changes in this PR would make it happy: jsoref@29041f2

Note: this PR does not include the action. If you're interested in running a spell check on every PR and push, that can be offered separately.

Additionally, this PR fixes a number of examples in the USAGE.md file.

Checklist

  • I acknowledge that all my contributions will be made under the project's license
  • I have made a material change to the repo (functionality, testing, spelling, grammar)
  • I have read the Contribution Guidelines and my PR follows them
    • I have read the guidelines but my commits are not following them right now as I expect to redo the commits after a discussion.
  • I have titled the PR appropriately
  • I have updated my branch with the main branch
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation about the functionality in the appropriate .md file
  • I have added inline documentation to the code I modified

If you have questions, please file a support ticket, or create a GitHub Issue in this repository.

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
@thinkingserious thinkingserious added the status: code review request requesting a community code review or review from Twilio label Oct 14, 2020
Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
Comment thread USAGE.md
request.setMethod(Method.POST);
request.setEndpoint("asm/groups");
request.setBody("{\"is_default\":true,\"description\":\"Suggestions for products our users might like.\",\"name\":\"Product) Suggestions\"}";
request.setBody("{\"is_default\":true,\"description\":\"Suggestions for products our users might like.\",\"name\":\"Product) Suggestions\"}");

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This pattern is repeated throughout this file and unfortunately, it means that the examples here don't work / compile without this change.

I am not confirming that they work with this change, but, they would have a chance ...

Comment thread USAGE.md
}
```
## Remove an IP from a domain authenticaiton.
## Remove an IP from a domain authentication.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Not every change in this file is a case of adding the ) to match a (.

Comment thread examples/user/README.md

## Security Settings Examples
- [Get Enforced TLS](GetEnforedTLS.java)
- [Get Enforced TLS](GetEnforcedTLS.java)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yes, the file needs to be renamed. Oddly, the class in the file isn't named to match the file name in accordance to general Java naming conventions.

Comment thread FIRST_TIMERS.md
Comment on lines -70 to +64
* [Go STMPAPI Client](https://github.com/sendgrid/smtpapi-go/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)
* [Python SMTPAPI Client](https://github.com/sendgrid/smtpapi-python/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3A%22status%3A+help+wanted%22)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

On the bright side, this repository consistently uses copy+paste (this makes fixing much easier than if it didn't...)

Comment thread CHANGELOG.md
--------------------------
**Library - Docs**
- [PR #477](https://github.com/sendgrid/sendgrid-java/pull/477): Run *.md documents through Grammer.ly. Thanks to [@vinird](https://github.com/vinird)!
- [PR #477](https://github.com/sendgrid/sendgrid-java/pull/477): Run *.md documents through Grammar.ly. Thanks to [@vinird](https://github.com/vinird)!

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

There's some irony here, since this is a .md file, and this change would have been flagged had it been run through grammar.ly.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

lulz

@jsoref

jsoref commented Oct 14, 2020

Copy link
Copy Markdown
Contributor Author

I'm happy to rewrite the commits or squash them as requested.

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

@childish-sambino childish-sambino left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM!

Comment thread CHANGELOG.md
--------------------------
**Library - Docs**
- [PR #477](https://github.com/sendgrid/sendgrid-java/pull/477): Run *.md documents through Grammer.ly. Thanks to [@vinird](https://github.com/vinird)!
- [PR #477](https://github.com/sendgrid/sendgrid-java/pull/477): Run *.md documents through Grammar.ly. Thanks to [@vinird](https://github.com/vinird)!

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

lulz

@childish-sambino childish-sambino changed the title chore: spelling chore: fix spelling typos Oct 14, 2020
@childish-sambino
childish-sambino merged commit 1344f93 into sendgrid:main Oct 14, 2020
@jsoref
jsoref deleted the spelling branch October 14, 2020 21:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

status: code review request requesting a community code review or review from Twilio

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants