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

Update type requirements used for multiple objects. #794

Merged
merged 3 commits into from Apr 30, 2019
Merged

Update type requirements used for multiple objects. #794

merged 3 commits into from Apr 30, 2019

Conversation

jphilipsen05
Copy link
Contributor

Checklist

  • [x ] I acknowledge that all my contributions will be made under the project's license
  • [x ] I have made a material change to the repo (functionality, testing, spelling, grammar)
  • [ x] I have read the [Contribution Guide] and my PR follows them
  • [ x] I updated my branch with the master branch
  • [ x] I have added tests that prove my fix is effective or that my feature works
  • [ x] I have added necessary documentation about the functionality in the appropriate .md file
  • [ x] I have added in line documentation to the code I modified

Short description of what this PR does:

  • This PR changes the in-line documentation of the objects in each commit. The types sepcifed for items in MailSettings and tracking Settings specify type string when it really should be a type object

If you have questions, please send an email to Twilio SendGrid, or file a GitHub Issue in this repository.

The notes state that the types are strings when the types really need to be FooterText and FooterHtml
The notes state that type text is required for substition_tag, but it requires a type OpenTrackingSubstitutionTag
It states that requirement types are string when they are need to by an object.
@thinkingserious thinkingserious added the status: code review request requesting a community code review or review from Twilio label Apr 29, 2019
@codecov
Copy link

codecov bot commented Apr 29, 2019

Codecov Report

Merging #794 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #794   +/-   ##
=======================================
  Coverage   79.97%   79.97%           
=======================================
  Files          69       69           
  Lines        2012     2012           
  Branches      338      338           
=======================================
  Hits         1609     1609           
  Misses        204      204           
  Partials      199      199
Impacted Files Coverage Δ
sendgrid/helpers/mail/footer_settings.py 81.25% <ø> (ø) ⬆️
sendgrid/helpers/mail/open_tracking.py 82.6% <ø> (ø) ⬆️
sendgrid/helpers/mail/subscription_tracking.py 80.48% <ø> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 266c2ab...6c26450. Read the comment docs.

@thinkingserious thinkingserious added difficulty: easy fix is easy in difficulty type: docs update documentation change not affecting the code labels Apr 30, 2019
@thinkingserious thinkingserious merged commit bc59079 into sendgrid:master Apr 30, 2019
@thinkingserious
Copy link
Contributor

Hello @jphilipsen05,

Thanks again for the PR!

We want to show our appreciation by sending you some swag. Could you please fill out this form so we can send it to you? Thanks!

Team SendGrid DX

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: code review request requesting a community code review or review from Twilio type: docs update documentation change not affecting the code
Projects
None yet
2 participants