Skip to content

Commit 86142a3

Browse files
committed
adds documentation re change to "id" kwargs
1 parent b774d18 commit 86142a3

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

doc/migration_v30.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,16 @@ Migration from v2 to v3
44
Changes to Existing Methods
55
===========================
66

7+
:py:func:`twitter.api.Api.CreateFavorite`
8+
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
9+
* kwarg param has been changed to ``status_id`` from ``id`` to be consistent
10+
with other method calls and avoid shadowing builtin function ``id``.
11+
12+
:py:func:`twitter.api.Api.DestroyFavorite`
13+
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
14+
* kwarg param has been changed to ``status_id`` from ``id`` to be consistent
15+
with other method calls and avoid shadowing builtin function ``id``.
16+
717
:py:func:`twitter.api.Api.GetBlocks`
818
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
919
* Method no longer accepts parameters ``user_id`` or ``screen_name`` as these are not honored by Twitter. The data returned will be for the authenticated user only.
@@ -35,10 +45,22 @@ Changes to Existing Methods
3545
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
3646
* No longer accepts ``cursor`` parameter. If you require granular control over the paging of the twitter.list.List members, please user twitter.api.Api.GetListMembersPaged instead.
3747

48+
49+
:py:func:`twitter.api.Api.GetStatusOembed`
50+
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
51+
* Kwarg ``id`` has been changed to ``status_id`` in keeping with the rest of
52+
the Api and to avoid shadowing a builtin.
53+
3854
:py:func:`twitter.api.Api.GetSearch`
3955
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
4056
* Adds ``raw_query`` method. See :ref:`raw_queries` for more information.
4157

58+
59+
:py:func:`twitter.api.Api.GetTrendsWoeid`
60+
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
61+
* Kwarg ``id`` has been changed to ``woeid`` in order to avoid shadowing
62+
a builtin and be more descriptive.
63+
4264
:py:func:`twitter.api.Api.GetUserStream`
4365
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
4466
* Parameter 'stall_warning' is now 'stall_warnings' in line with GetStreamFilter and Twitter's naming convention. This should now actually return stall warnings, whereas it did not have any effect previously.

0 commit comments

Comments
 (0)