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.

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

docs: Fixed a broken link to the api reference and added an ES8 syntax code example. #1357

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

Conversation

camerondaly
Copy link

@camerondaly camerondaly commented Apr 19, 2022

Fixes

Hi! This is my first time contributing here -- I apologize if I've gone about any part of this incorrectly. I'm happy to follow up and resolve any issues.

I'm proposing one fix and one addition:

  1. The link on line 49 in the README points to a page that doesn't exist (404). I've provided a link to what I think is the new home for the API reference.
  1. From what I've seen, the docs/README's here often provide both ES6 and ES8 examples, so I went ahead and added an ES8 snippet to correspond with the existing ES6 snippet.

Hopefully this is helpful! I'm enjoying using SendGrid in my own projects. Thanks!

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 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 the 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant