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: specify custom arguments must have string values #784

Conversation

OrthoDex
Copy link
Contributor

@OrthoDex OrthoDex commented Oct 7, 2018

Fixes #658

Checklist

  • I have made a material change to the repo (functionality, testing, spelling, grammar)
  • I have read the [Contribution Guide] and my PR follows them.
  • I updated my branch with the master 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 in line documentation to the code I modified

Short description of what this PR does:

  • Update mentions of customArgs field in the docs to reflect that it takes only string value
  • Add an error handling section to the kitchen sink example to notify future users.

If you have questions, please send an email to Sendgrid, or file a Github Issue in this repository.

cc @thinkingserious

@thinkingserious thinkingserious added the status: code review request requesting a community code review or review from Twilio label Oct 7, 2018
@SendGridDX
Copy link
Collaborator

SendGridDX commented Oct 7, 2018

CLA assistant check
All committers have signed the CLA.

Copy link
Contributor

@reedsa reedsa left a comment

Choose a reason for hiding this comment

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

Nice job, thanks for this documentation! Added a minor feedback item, if you want to change it. Happy to approve if you disagree.

@@ -48,3 +48,7 @@ sgMail
.then(() => console.log('Mail sent successfully'))
.catch(error => console.error(error.toString()));
```

### Error Handling:
Copy link
Contributor

Choose a reason for hiding this comment

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

Not a big deal but perhaps this title should be Caveats?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

agreed @reedsa , I'll update the PR

@reedsa reedsa added status: waiting for feedback waiting for feedback from the submitter and removed status: code review request requesting a community code review or review from Twilio labels Oct 10, 2018
@devchas devchas added hacktoberfest difficulty: easy fix is easy in difficulty type: docs update documentation change not affecting the code labels Oct 11, 2018
Copy link
Contributor

@reedsa reedsa left a comment

Choose a reason for hiding this comment

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

Great work, thanks for the contribution!

@reedsa reedsa added status: ready for deploy code ready to be released in next deploy and removed status: waiting for feedback waiting for feedback from the submitter labels Oct 15, 2018
@OrthoDex
Copy link
Contributor Author

Hi @reedsa, can this be merged in?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
difficulty: easy fix is easy in difficulty status: ready for deploy code ready to be released in next deploy type: docs update documentation change not affecting the code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document that custom_args properties must be strings (until fixed at API level)
5 participants