Expand doc for TransferData to detail parameters #231
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
jaswilli
reviewed
Oct 4, 2017
globus_sdk/transfer/data.py
Outdated
| @@ -1,6 +1,6 @@ | |||
| """ | |||
| Data helper classes for constructing Transfer API documents. All classes should | |||
| extend ``dict``, so they can be passed seemlesly to | |||
| extend ``dict``, so they can be passed seamlesly to | |||
There was a problem hiding this comment.
Haha, yes, typo fixing should actually fix the typos...
Specifies parameter types, defaults, and meaning. Full understanding of behaviors will probably always require reading the API docs, but this should eliminate confusion about things like Endpoint Documents (dicts) and Endpoint IDs (strings).
sirosen
force-pushed
the
docs/transfer-data
branch
from
9d38b0b
to
35207a1
Compare
|
Amended to fix a typo which Jason caught and remove a trailing space which made linting fail. |
sirosen
added a commit
to sirosen/globus-sdk-python
that referenced
this pull request
Oct 30, 2017
Closed issues since 1.2.1: - globus#232 - globus#233 - globus#231 - globus#229 Three of these are documentation updates, and one is the fix for installing a `tests` package.
sirosen
added a commit
to sirosen/globus-sdk-python
that referenced
this pull request
Nov 1, 2017
Closed issues since 1.2.1: - globus#232 - globus#233 - globus#231 - globus#229 Three of these are documentation updates, and one is the fix for installing a `tests` package.
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.
Specifies parameter types, defaults, and meaning. Full understanding of behaviors will probably always require reading the API docs, but this should eliminate confusion about things like Endpoint Documents (dicts) and Endpoint IDs (strings).
I want to do another round of this to document
DeleteDataonce we're happy with the results here.