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 docs for Address objects #2224

Merged
merged 3 commits into from Oct 19, 2017
Merged

Fix docs for Address objects #2224

merged 3 commits into from Oct 19, 2017

Conversation

baudehlo
Copy link
Collaborator

@baudehlo baudehlo commented Oct 18, 2017

Fixes #2220

Changes proposed in this pull request:

  • Link references to Address objects to the node module behind them.

Checklist:

  • docs updated
  • tests updated
  • Changes updated

@codecov
Copy link

codecov bot commented Oct 18, 2017

Codecov Report

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

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #2224   +/-   ##
=======================================
  Coverage   59.41%   59.41%           
=======================================
  Files          28       28           
  Lines        6051     6051           
  Branches     1497     1497           
=======================================
  Hits         3595     3595           
  Misses       2456     2456

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 87d5cf5...36e082c. Read the comment docs.

@@ -361,3 +361,5 @@ In case you need notes in the new transaction that `send_email()` creates, you s
```notes``` option, like so:

outbound.send_email(from, to, contents, outnext, { notes: transaction.notes });

[1]: `Address` objects are address-rfc2821 objects. See https://github.com/haraka/node-address-rfc2821
Copy link
Member

Choose a reason for hiding this comment

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

Recursive links?

[1]: Address objects are instances of address-rfc2821.

source:
[1]: Address objects are instances of [address-rfc2821](https://github.com/haraka/node-address-rfc2821).

Copy link
Member

@msimerson msimerson left a comment

Choose a reason for hiding this comment

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

the URL in the footnote would be better as a link but this is an improvement.

@baudehlo
Copy link
Collaborator Author

Fair enough, though github's markdown viewer does turn them into links, so shrug.

@baudehlo baudehlo merged commit 0c95e42 into master Oct 19, 2017
@baudehlo baudehlo deleted the fix_address_docs branch October 19, 2017 15:58
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