Docs update #159
Merged
Docs update #159
Conversation
This file contains hidden or 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
|
Verified that @kelseymorris95 has signed the CLA. Thanks for the pull request! |
HISTORY.rst
Outdated
|
|
||
| **Breaking Changes** | ||
|
|
||
| - ``Events.get_events(...)`` now returns a list of ``Event`` instances rather than a list of ``dicts`` s |
HISTORY.rst
Outdated
|
|
||
| - ``Events.get_events(...)`` now returns a list of ``Event`` instances rather than a list of ``dicts`` s | ||
| representing ``Event`` s. ``Event`` inherits from ``Mapping`` but will not have all the same capabilities as | ||
| ``dict`` . |
Contributor
There was a problem hiding this comment.
Let's add a sub-bullet about how to migrate. Something like:
- .
- Your code is affected if you use
Events.get_events(...)and expect a list ofdictinstead of a list ofMapping. For example, if you use__setitem__(event['key'] = value),update(), orcopy(), or if your code depends on thestrorreprof the event. Use of__getitem__(event['key']),get, and otherMappingmethods is unaffected. See https://docs.python.org/2.7/library/collections.html#collections-abstract-base-classes for methods supported onMappinginstances. - How to migrate: if you still have the need to treat the events like a
dict, then you can get a deepcopy of the originaldictwith the new attributeresponse_object.
- Your code is affected if you use
Contributor
|
👍 |
added 3 commits
August 19, 2016 09:43
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.
No description provided.