Fix documentation bugs [ci skip]

sferik · Jan 9, 2013 · 45213d1 · 45213d1
1 parent 46327e7
commit 45213d1
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 8 deletions.
diff --git a/lib/twitter/api/friends_and_followers.rb b/lib/twitter/api/friends_and_followers.rb
@@ -119,11 +119,11 @@ def friendships_outgoing(options={})
       # @authentication_required Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @return [Array<Twitter::User>] The followed users.
-      # @overload(*users)
+      # @overload follow(*users)
       #   @param users [Array<Integer, String, Twitter::User>, Set<Integer, String, Twitter::User>] An array of Twitter user IDs, screen names, or objects.
       #   @example Follow @sferik
       #     Twitter.follow('sferik')
-      # @overload(*users, options)
+      # @overload follow(*users, options)
       #   @param users [Array<Integer, String, Twitter::User>, Set<Integer, String, Twitter::User>] An array of Twitter user IDs, screen names, or objects.
       #   @param options [Hash] A customizable set of options.
       #   @option options [Boolean] :follow (false) Enable notifications for the target user.
@@ -184,7 +184,7 @@ def follow!(*args)
       #   @param users [Array<Integer, String, Twitter::User>, Set<Integer, String, Twitter::User>] An array of Twitter user IDs, screen names, or objects.
       #   @example Unfollow @sferik
       #     Twitter.unfollow('sferik')
-      # @overload unfollow(*users)
+      # @overload unfollow(*users, options)
       #   @param users [Array<Integer, String, Twitter::User>, Set<Integer, String, Twitter::User>] An array of Twitter user IDs, screen names, or objects.
       #   @param options [Hash] A customizable set of options.
       def unfollow(*args)

diff --git a/lib/twitter/api/lists.rb b/lib/twitter/api/lists.rb
@@ -21,11 +21,11 @@ module Lists
       # @authentication_required Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @return [Array<Twitter::List>]
-      # @overload memberships(options={})
+      # @overload lists(options={})
       #   @param options [Hash] A customizable set of options.
       #   @example Returns all lists the authenticating user subscribes to
       #     Twitter.lists
-      # @overload memberships(user, options={})
+      # @overload lists(user, options={})
       #   @param user [Integer, String, Twitter::User] A Twitter user ID, screen name, or object.
       #   @param options [Hash] A customizable set of options.
       #   @example Returns all lists that @sferik subscribes to

diff --git a/lib/twitter/api/tweets.rb b/lib/twitter/api/tweets.rb
@@ -163,11 +163,11 @@ def retweet(*args)
       # @raise [Twitter::Error::AlreadyRetweeted] Error raised when tweet has already been retweeted.
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @return [Array<Twitter::Tweet>] The original tweets with retweet details embedded.
-      # @overload retweet(*ids)
+      # @overload retweet!(*ids)
       #   @param ids [Array<Integer>, Set<Integer>] An array of Tweet IDs.
       #   @example Retweet the Tweet with the ID 28561922516
-      #     Twitter.retweet(28561922516)
-      # @overload retweet(*ids, options)
+      #     Twitter.retweet!(28561922516)
+      # @overload retweet!(*ids, options)
       #   @param ids [Array<Integer>, Set<Integer>] An array of Tweet IDs.
       #   @param options [Hash] A customizable set of options.
       #   @option options [Boolean, String, Integer] :trim_user Each tweet returned in a timeline will include a user object with only the author's numerical ID when set to true, 't' or 1.