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

Fix typography on mail helper refactor proposal #353

Conversation

yothinix
Copy link
Contributor

@yothinix yothinix commented Oct 3, 2017

I found these typography during study on the proposal spec.

Changes proposed in this pull request:

  • Change variable from tos to to_emails on Send Multiple Emails to Multiple Recipients example
  • Change typo of to_email to to_emails on Kitchen Sink example
  • Change attribute headers to be header on Kitchen Sink example
  • Change attribute global_headers to be global_headers on Kitchen Sink example

connect to #347

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

SendGridDX commented Oct 3, 2017

CLA assistant check
All committers have signed the CLA.

@thinkingserious thinkingserious added difficulty: easy fix is easy in difficulty hacktoberfest labels Oct 4, 2017
@@ -105,7 +105,7 @@ import sendgrid
from sendgrid.helpers.mail import *

msg = Mail(from_email=From('from@example.com', 'From Name'),
to_email=To('to@example.com', 'To Name'),
to_emails=To('to@example.com', 'To Name'),
Copy link
Contributor

Choose a reason for hiding this comment

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

This is a single email address, should it stay singular?

Copy link
Contributor

Choose a reason for hiding this comment

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

I believe it should stay singular in this case.

@@ -175,7 +175,7 @@ msg.bcc = [

msg.header = Header('X-Test5', 'Test5', p=1)
msg.header = Header('X-Test6', 'Test6', p=1)
msg.headers = [
msg.header = [
Copy link
Contributor

Choose a reason for hiding this comment

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

This can be multiple headers, should it stay plural?

Copy link
Contributor

Choose a reason for hiding this comment

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

I think it should stay plural in that case.

@@ -228,7 +228,7 @@ msg.attachment = [
msg.template_id = TemplateId('13b8f94f-bcae-4ec6-b752-70d6cb59f932')

msg.global_header = Header('X-Day', 'Monday')
msg.global_headers = [
msg.global_header = [
Copy link
Contributor

Choose a reason for hiding this comment

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

This can be multiple headers, should it stay plural?

Copy link
Contributor

Choose a reason for hiding this comment

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

I think this should remain plural.

Copy link
Contributor

@mbernier mbernier left a comment

Choose a reason for hiding this comment

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

I have left some comments on the plurality of the var names that are changed in this PR

@@ -105,7 +105,7 @@ import sendgrid
from sendgrid.helpers.mail import *

msg = Mail(from_email=From('from@example.com', 'From Name'),
to_email=To('to@example.com', 'To Name'),
to_emails=To('to@example.com', 'To Name'),
Copy link
Contributor

Choose a reason for hiding this comment

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

I believe it should stay singular in this case.

@@ -175,7 +175,7 @@ msg.bcc = [

msg.header = Header('X-Test5', 'Test5', p=1)
msg.header = Header('X-Test6', 'Test6', p=1)
msg.headers = [
msg.header = [
Copy link
Contributor

Choose a reason for hiding this comment

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

I think it should stay plural in that case.

@@ -228,7 +228,7 @@ msg.attachment = [
msg.template_id = TemplateId('13b8f94f-bcae-4ec6-b752-70d6cb59f932')

msg.global_header = Header('X-Day', 'Monday')
msg.global_headers = [
msg.global_header = [
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this should remain plural.

@mbernier
Copy link
Contributor

mbernier commented Nov 1, 2017

@yothinix

We have not been able to merge your Pull Request, but because you are awesome - we wanted to make sure you could still get a SendGrid Hacktoberfest shirt.

Please go fill out our swag form before Nov 5th and we will send the shirt! (We know that you might have tried this before and it didn’t work, sorry about that!)

You have till Nov 5th to fill out this form in order to get the Hacktoberfest shirt!

Thank you for contributing during Hacktoberfest! We hope to see you in the repos soon! Just so you know, we always give away a SendGrid shirt for your first ever non-Hacktoberfest PR that gets merged.

@thinkingserious
Copy link
Contributor

Hi @yothinix,

Could you please update this PR based on our feedback?

Thanks!

With Best Regards,

Elmer

@yothinix
Copy link
Contributor Author

yothinix commented Dec 8, 2017

@thinkingserious Just update as in feedback.

@thinkingserious
Copy link
Contributor

Thank you @yothinix!

@thinkingserious thinkingserious merged commit a54b764 into sendgrid:master Dec 16, 2017
@thinkingserious
Copy link
Contributor

Hello @yothinix,

Thanks again for the PR!

We appreciate your contribution and look forward to continued collaboration. Thanks!

Team SendGrid DX

@yothinix yothinix deleted the fix-typography-on-mail-helper-proposal branch December 20, 2017 09:23
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants