Organize documentation parameters alphabetically
authorHarmon <Harmon758@gmail.com>
Tue, 7 May 2019 05:21:47 +0000 (00:21 -0500)
committerGitHub <noreply@github.com>
Tue, 7 May 2019 05:21:47 +0000 (00:21 -0500)
docs/parameters.rst

index 055b09c959aa508d61ad6b090c159e637a2946fc..f95004d4d0ecafa10b4c94b71ca79111da736a5e 100644 (file)
@@ -1,20 +1,20 @@
 .. API parameters:
 
-.. |since_id| replace:: Returns only statuses with an ID greater than (that is, more recent than) the specified ID.
-.. |max_id| replace:: Returns only statuses with an ID less than (that is, older than) or equal to the specified ID.
 .. |count| replace:: Specifies the number of statuses to retrieve.
-.. |page| replace:: Specifies the page of results to retrieve. Note: there are pagination limits.
-.. |uid| replace:: Specifies the ID or screen name of the user.
-.. |user_id| replace:: Specifies the ID of the user. Helpful for disambiguating when a valid user ID is also a valid screen name.
-.. |screen_name| replace:: Specifies the screen name of the user. Helpful for disambiguating when a valid screen name is also a user ID.
-.. |sid| replace:: The numerical ID of the status.
 .. |cursor| replace:: Breaks the results into pages. Provide a value of  -1 to begin paging. Provide values as returned to in the response body's next_cursor and previous_cursor attributes to page back and forth in the list.
-.. |exclude| replace:: Setting this equal to hashtags will remove all hashtags from the trends list.
 .. |date| replace:: Permits specifying a start date for the report. The date should be formatted YYYY-MM-DD.
-.. |slug| replace:: the slug name or numerical ID of the list
+.. |exclude| replace:: Setting this equal to hashtags will remove all hashtags from the trends list.
+.. |full_text| replace:: A boolean indicating whether or not the full text of a message should be returned. If False the message text returned will be truncated to 140 chars. Defaults to False.
+.. |include_user_entities| replace:: The user object entities node will not be included when set to false. Defaults to true.
 .. |list_mode| replace:: Whether your list is public or private. Values can be public or private. Lists are public by default if no mode is specified.
 .. |list_owner| replace:: the screen name of the owner of the list
-.. |full_text| replace:: A boolean indicating whether or not the full text of a message should be returned. If False the message text returned will be truncated to 140 chars. Defaults to False.
+.. |max_id| replace:: Returns only statuses with an ID less than (that is, older than) or equal to the specified ID.
+.. |page| replace:: Specifies the page of results to retrieve. Note: there are pagination limits.
+.. |screen_name| replace:: Specifies the screen name of the user. Helpful for disambiguating when a valid screen name is also a user ID.
+.. |sid| replace:: The numerical ID of the status.
+.. |since_id| replace:: Returns only statuses with an ID greater than (that is, more recent than) the specified ID.
 .. |skip_status| replace:: When set to either true, t or 1 statuses will not be included in the returned user objects. Defaults to false.
-.. |include_user_entities| replace:: The user object entities node will not be included when set to false. Defaults to true.
+.. |slug| replace:: the slug name or numerical ID of the list
+.. |uid| replace:: Specifies the ID or screen name of the user.
+.. |user_id| replace:: Specifies the ID of the user. Helpful for disambiguating when a valid user ID is also a valid screen name.