X Tutup
Skip to content

Commit c53fada

Browse files
committed
alphabetize migration guide
1 parent c879c8c commit c53fada

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

doc/migration_v30.rst

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
Migration from v2 to v3
22
-----------------------
33

4-
54
Changes to Existing Methods
65
===========================
76

@@ -16,6 +15,11 @@ Changes to Existing Methods
1615
* Method now takes an optional parameter of ``total_count``, which limits the number of users to return. If this is not set, the data returned will be all users following the specified user.
1716
* The kwarg ``include_user_entities`` now defaults to ``True``. This was set to ``False`` previously, but would not be included in query parameters sent to Twitter. Without the query parameter in the URL, Twitter would default to returning user_entities, so this change makes this behavior explicit.
1817

18+
:py:func:`twitter.api.Api.GetFollowersPaged`
19+
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
20+
* The third value of the tuple returned by this method is now a list of twitter.User objects in accordance with its doc string rather than the raw data from API.
21+
* The kwarg ``include_user_entities`` now defaults to ``True``. This was set to ``False`` previously, but would not be included in query parameters sent to Twitter. Without the query parameter in the URL, Twitter would default to returning user_entities, so this change makes this behavior explicit and consistent with the previously ambiguous behavior.
22+
1923
:py:func:`twitter.api.Api.GetFriends`
2024
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
2125
* Method no longer honors a ``count`` or ``cursor`` parameter. These have been deprecated in favor of making this method explicitly a convenience function to return a list of every ``twitter.User`` who is followed by the specified or authenticated user. A warning will be raised if ``count`` or ``cursor`` is passed with the expectation that breaking behavior will be introduced in a later version.
@@ -27,11 +31,6 @@ Changes to Existing Methods
2731
* The third value of the tuple returned by this method is now a list of twitter.User objects in accordance with its doc string rather than the raw data from API.
2832
* The kwarg ``include_user_entities`` now defaults to ``True``. This was set to ``False`` previously, but would not be included in query parameters sent to Twitter. Without the query parameter in the URL, Twitter would default to returning user_entities, so this change makes this behavior explicit.
2933

30-
:py:func:`twitter.api.Api.GetFollowersPaged`
31-
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
32-
* The third value of the tuple returned by this method is now a list of twitter.User objects in accordance with its doc string rather than the raw data from API.
33-
* The kwarg ``include_user_entities`` now defaults to ``True``. This was set to ``False`` previously, but would not be included in query parameters sent to Twitter. Without the query parameter in the URL, Twitter would default to returning user_entities, so this change makes this behavior explicit and consistent with the previously ambiguous behavior.
34-
3534
:py:func:`twitter.api.Api.GetSearch`
3635
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
3736
* Adds ``raw_query`` method. See :ref:`raw_queries` for more information.
@@ -62,7 +61,6 @@ Deprecation
6261
New Methods
6362
===========
6463

65-
6664
:py:func:`twitter.api.Api.GetBlocksIDs`
6765
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
6866
* Returns **all** the users currently blocked by the authenticated user as user IDs. The user IDs will be integers.

0 commit comments

Comments
 (0)
X Tutup