Option keys need to be hyphenated, not underscored

hundredwatt · Jan 23, 2014 · ed4d43c · ed4d43c
1 parent 3f097a2
commit ed4d43c
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/lib/linked_in/api.rb b/lib/linked_in/api.rb
@@ -21,8 +21,8 @@ module Api
     #  @option share [String] :comment
     #  @option share [String] :content
     #  @option share [String] :title
-    #  @option share [String] :submitted_url TODO
-    #  @option share [String] :submitted_image_url TODO
+    #  @option share [String] :submitted-url
+    #  @option share [String] :submitted-image-url
     #  @option share [String] :description
     #  @option share [String] :visibility
     #  @option share [String] :code

diff --git a/lib/linked_in/api/companies.rb b/lib/linked_in/api/companies.rb
@@ -36,7 +36,7 @@ def company(options = {})
       # @see http://developer.linkedin.com/reading-company-shares
       #
       # @macro company_path_options
-      # @option options [String] :event_type
+      # @option options [String] :event-type
       # @option options [String] :count
       # @option options [String] :start
       # @return [LinkedIn::Mash]

diff --git a/lib/linked_in/api/people.rb b/lib/linked_in/api/people.rb
@@ -15,7 +15,7 @@ module People
       #
       # @see http://developer.linkedin.com/documents/profile-api
       # @macro person_path_options
-      # @option options [string] :secure_urls if 'true' URLs in responses will be HTTPS
+      # @option options [string] :secure-urls if 'true' URLs in responses will be HTTPS
       # @return [LinkedIn::Mash]
       def profile(options={})
         path = person_path(options)