Document exclude parameter

sferik · Sep 14, 2011 · 22a7f38 · 22a7f38
1 parent f9f0c1f
commit 22a7f38
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/lib/twitter/client/local_trends.rb b/lib/twitter/client/local_trends.rb
@@ -27,6 +27,7 @@ def trend_locations(options={})
       # @response_format `json`
       # @param woeid [Integer] The {https://developer.yahoo.com/geo/geoplanet Yahoo! Where On Earth ID} of the location to return trending information for. WOEIDs can be retrieved by calling {Twitter::Client::LocalTrends#trend_locations}. Global information is available by using 1 as the WOEID.
       # @param options [Hash] A customizable set of options.
+      # @option options [String] :exclude Setting this equal to 'hashtags' will remove all hashtags from the trends list.
       # @return [Array]
       # @example Return the top 10 trending topics for San Francisco
       #   Twitter.local_trends(2487956)

diff --git a/lib/twitter/client/trends.rb b/lib/twitter/client/trends.rb
@@ -10,6 +10,7 @@ module Trends
       # @requires_authentication No
       # @response_format `json`
       # @param options [Hash] A customizable set of options.
+      # @option options [String] :exclude Setting this equal to 'hashtags' will remove all hashtags from the trends list.
       # @return [Array]
       # @example Return the top ten topics that are currently trending on Twitter
       #   Twitter.trends
@@ -25,6 +26,7 @@ def trends(options={})
       # @requires_authentication No
       # @response_format `json`
       # @param options [Hash] A customizable set of options.
+      # @option options [String] :exclude Setting this equal to 'hashtags' will remove all hashtags from the trends list.
       # @return [Array]
       # @example Return the current top 10 trending topics on Twitter
       #   Twitter.trends_current