Add return_path param to send() docs #169
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jgzamora
commented
May 18, 2018
sparkpost/transmissions.py
Outdated
| used | ||
| :param bool use_draft_template: Default to False. Set to true if you | ||
| :param str template: ID of template to be used. Setting a template | ||
| overrides set the HTML and text params |
sparkpost/transmissions.py
Outdated
| if dict: ``{'address': {'name': 'Name', 'email': 'me' }}`` | ||
| :param str recipient_list: ID of recipient list. If this is set, | ||
| the `recipients` | ||
| param will be ignored |
There was a problem hiding this comment.
unnecessary extra line
| :param str description: Description of transmission | ||
| :param str campaign: Campaign of transmission | ||
| :param dict metadata: Any data you want to send along with | ||
| transmission, used in WebHooks | ||
| :param dict substitution_data: Corresponds to substitutions in | ||
| html/text content. See `substitutions reference | ||
| <https://developers.sparkpost.com/api/substitutions-reference.html>`_. |
There was a problem hiding this comment.
I did this because of line length linting, but it's smart enough to ignore links. Link works fine though
avigoldman
previously approved these changes
May 18, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixing missing param documentation raised in #161. Also updated some of the other docs that had small errors.