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

Adding documentation and consolidating some code for readability #89

Merged
merged 1 commit into from Mar 22, 2016

Conversation

natechicago
Copy link

I've added documentation to this class to make it easier for others to understand (at a quick glance) --

  • the differences between errors and warnings
  • the different categories of warnings
  • the exact RFCs that this class validates against (please confirm this list)

Additionally, some simple refactorings were applied to make a few parts of the code quicker/easier to read. They're logically equivalent to the original code, and the tests still pass.

* RFC-6530: Overview and Framework for Internationalized Email
* RFC-1123 section 2.1: Requirements for Internet Hosts -- Application and Support
* RFC-4291 section 2.2: IP Version 6 Addressing Architecture
*
Copy link
Owner

Choose a reason for hiding this comment

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

Please add

which are for SMTPUTF8 international emails.

Copy link
Author

Choose a reason for hiding this comment

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

Okay, will do. In my mind, I had been treating 6530 as the 'parent' to 6531 and 6532, but I suppose that's not really a fair way of looking at those RFCs!

@egulias
Copy link
Owner

egulias commented Mar 15, 2016

Thanks @natechicago
I added a comment about the list of supported RFCs.
I'll merge when updated.

egulias added a commit that referenced this pull request Mar 22, 2016
Adding documentation and consolidating some code for readability
@egulias egulias merged commit afc6adc into egulias:1.2 Mar 22, 2016
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

2 participants