friends_and_followers.rb in twitter-5.7.1

- old
+ new

@@ -19,17 +19,15 @@
       # @return [Twitter::Cursor]
       # @overload friend_ids(options = {})
       #   Returns an array of numeric IDs for every user the authenticated user is following
       #
       #   @param options [Hash] A customizable set of options.
-      #   @option options [Integer] :cursor (-1) Breaks the results into pages. This is recommended for users who are following many users. Provide a value of -1 to begin paging. Provide values as returned in the response body's next_cursor and previous_cursor attributes to page back and forth in the list.
       # @overload friend_ids(user, options = {})
       #   Returns an array of numeric IDs for every user the specified user is following
       #
       #   @param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
       #   @param options [Hash] A customizable set of options.
-      #   @option options [Integer] :cursor (-1) Breaks the results into pages. Provide values as returned in the response objects's next_cursor and previous_cursor attributes to page back and forth in the list.
       def friend_ids(*args)
         cursor_from_response_with_user(:ids, nil, :get, '/1.1/friends/ids.json', args)
       end
 
       # @see https://dev.twitter.com/docs/api/1.1/get/followers/ids
@@ -39,17 +37,15 @@
       # @return [Twitter::Cursor]
       # @overload follower_ids(options = {})
       #   Returns an array of numeric IDs for every user following the authenticated user
       #
       #   @param options [Hash] A customizable set of options.
-      #   @option options [Integer] :cursor (-1) Breaks the results into pages. Provide values as returned in the response objects's next_cursor and previous_cursor attributes to page back and forth in the list.
       # @overload follower_ids(user, options = {})
       #   Returns an array of numeric IDs for every user following the specified user
       #
       #   @param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
       #   @param options [Hash] A customizable set of options.
-      #   @option options [Integer] :cursor (-1) Breaks the results into pages. This is recommended for users who are following many users. Provide a value of -1 to begin paging. Provide values as returned in the response body's next_cursor and previous_cursor attributes to page back and forth in the list.
       def follower_ids(*args)
         cursor_from_response_with_user(:ids, nil, :get, '/1.1/followers/ids.json', args)
       end
 
       # Returns the relationship of the authenticating user to the comma separated list of up to 100 screen_names or user_ids provided. Values for connections can be: following, following_requested, followed_by, none.
@@ -76,11 +72,10 @@
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @return [Twitter::Cursor]
       # @param options [Hash] A customizable set of options.
-      # @option options [Integer] :cursor (-1) Breaks the results into pages. Provide values as returned in the response objects's next_cursor and previous_cursor attributes to page back and forth in the list.
       def friendships_incoming(options = {})
         perform_with_cursor(:get, '/1.1/friendships/incoming.json', options, :ids)
       end
 
       # Returns an array of numeric IDs for every protected user for whom the authenticating user has a pending follow request
@@ -89,11 +84,10 @@
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @return [Twitter::Cursor]
       # @param options [Hash] A customizable set of options.
-      # @option options [Integer] :cursor (-1) Breaks the results into pages. Provide values as returned in the response objects's next_cursor and previous_cursor attributes to page back and forth in the list.
       def friendships_outgoing(options = {})
         perform_with_cursor(:get, '/1.1/friendships/outgoing.json', options, :ids)
       end
 
       # Allows the authenticating user to follow the specified users, unless they are already followed
@@ -221,44 +215,40 @@
       # @return [Twitter::Cursor]
       # @overload followers(options = {})
       #   Returns a cursored collection of user objects for users following the authenticated user.
       #
       #   @param options [Hash] A customizable set of options.
-      #   @option options [Integer] :cursor (-1) Breaks the results into pages. This is recommended for users who are following many users. Provide a value of -1 to begin paging. Provide values as returned in the response body's next_cursor and previous_cursor attributes to page back and forth in the list.
       #   @option options [Boolean, String, Integer] :skip_status Do not include contributee's Tweets when set to true, 't' or 1.
       #   @option options [Boolean, String, Integer] :include_user_entities The user entities node will be disincluded when set to false.
       # @overload followers(user, options = {})
       #   Returns a cursored collection of user objects for users following the specified user.
       #
       #   @param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
       #   @param options [Hash] A customizable set of options.
-      #   @option options [Integer] :cursor (-1) Breaks the results into pages. Provide values as returned in the response objects's next_cursor and previous_cursor attributes to page back and forth in the list.
       #   @option options [Boolean, String, Integer] :skip_status Do not include contributee's Tweets when set to true, 't' or 1.
       #   @option options [Boolean, String, Integer] :include_user_entities The user entities node will be disincluded when set to false.
       def followers(*args)
         cursor_from_response_with_user(:users, Twitter::User, :get, '/1.1/followers/list.json', args)
       end
 
       # Returns a cursored collection of user objects for every user the specified user is following (otherwise known as their "friends").
       #
-      # @see https://dev.twitter.com/docs/api/1.1/get/friendships/show
+      # @see https://dev.twitter.com/docs/api/1.1/get/friends/list
       # @rate_limited Yes
       # @authentication Requires user context
-      # @raise [Twittera:Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @return [Twitter::Cursor]
       # @overload friends(options = {})
       #   Returns a cursored collection of user objects for every user the authenticated user is following (otherwise known as their "friends").
       #
       #   @param options [Hash] A customizable set of options.
-      #   @option options [Integer] :cursor (-1) Breaks the results into pages. This is recommended for users who are following many users. Provide a value of -1 to begin paging. Provide values as returned in the response body's next_cursor and previous_cursor attributes to page back and forth in the list.
       #   @option options [Boolean, String, Integer] :skip_status Do not include contributee's Tweets when set to true, 't' or 1.
       #   @option options [Boolean, String, Integer] :include_user_entities The user entities node will be disincluded when set to false.
       # @overload friends(user, options = {})
       #   Returns a cursored collection of user objects for every user the specified user is following (otherwise known as their "friends").
       #
       #   @param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
       #   @param options [Hash] A customizable set of options.
-      #   @option options [Integer] :cursor (-1) Breaks the results into pages. Provide values as returned in the response objects's next_cursor and previous_cursor attributes to page back and forth in the list.
       #   @option options [Boolean, String, Integer] :skip_status Do not include contributee's Tweets when set to true, 't' or 1.
       #   @option options [Boolean, String, Integer] :include_user_entities The user entities node will be disincluded when set to false.
       def friends(*args)
         cursor_from_response_with_user(:users, Twitter::User, :get, '/1.1/friends/list.json', args)
       end