fitbit_api 0.12.1 → 0.12.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cced5004604fd14351b0539ffe29efc102d6297f0a73e6d64edd6e4f18b24975
-  data.tar.gz: 66a12b7d4b92c0c75e0958b5f69ddbb87f376bc4196bebd8884804df09bf33d7
+  metadata.gz: 78cae3c27a67636b099e84c993d65ca42e2039dd3caba794df413baf947dc7eb
+  data.tar.gz: 8cd276fc40a20b3592c54e7b4e53f86b450ce8b6f57160151080f9bf8586b557
 SHA512:
-  metadata.gz: 2d3b0ee2261afc4a254dc3673796198e9dc832e78a21241b84a7c11a0f39d396fc8647abf6826a0c4aa3a3be731a63b812dcf4d0de9a45c3fb6ccae9b9297612
-  data.tar.gz: 67526aba18a4fe518d5d0b05e8a48979009fc3435ed627c59bff341872e6917387c14ae83709d2ae84c0ff5e16000bf2fca55a89870a436f41b5a389b6b33a2a
+  metadata.gz: f197a5a6e3e8bd08c3d435b44fde8953716f9a1a589d6ea46ae469bb875b77ee39b1f0a289d1e66cd5f2bd055051e5f7dad73f468c628ab9a5ce4f41be7b0758
+  data.tar.gz: 062e014f64ab3780554c2e8f705bcee89a9c74ce3d2119371230207849fb991d777197722641f55cb9983186aa0a97960218eb7413e766fd9ff41e07557226ab

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+0.12.2
+------
+- Fix docs formatting
+
 0.12.1
 ------
 - Some docs improvements

data/lib/fitbit_api/alarms.rb

@@ -2,7 +2,7 @@ module FitbitAPI
   class Client
     # Returns a list of the set alarms connected to a user's account.
     #
-    # @params tracker_id [Integer] The ID of the tracker for which the data is returned
+    # @param tracker_id [Integer] The ID of the tracker for which the data is returned
 
     def alarms(tracker_id)
       get("user/#{user_id}/devices/tracker/#{tracker_id}/alarms.json")

data/lib/fitbit_api/food.rb

@@ -8,7 +8,7 @@ module FitbitAPI
 
     # Retrieves a list of public foods from the Fitbit foods database and private foods the user created
     #
-    # @params query [String] The search query
+    # @param query [String] The search query
 
     def search_foods(params)
       get("foods/search.json", params)
@@ -28,7 +28,7 @@ module FitbitAPI
 
     # Creates a new private food for a user
     #
-    # @params body [Hash] The POST request body
+    # @param body [Hash] The POST request body
 
     def create_food(body)
       post("user/#{user_id}/foods.json", body)
@@ -36,7 +36,7 @@ module FitbitAPI
 
     # Deletes a custom food created by the user
     #
-    # @params food_id [Integer] The ID of the food to be deleted
+    # @param food_id [Integer] The ID of the food to be deleted
 
     def delete_food(food_id)
       delete("user/#{user_id}/foods/#{food_id}.json")
@@ -44,7 +44,7 @@ module FitbitAPI
 
     # Creates a food log entry
     #
-    # @params body [Hash] The POST request body
+    # @param body [Hash] The POST request body
 
     def create_food_log(body)
       post("user/#{user_id}/foods/log.json", body)
@@ -52,8 +52,8 @@ module FitbitAPI
 
     # Updates the quantity or calories consumed for a user's food log entry with the given Food Log ID
     #
-    # @params food_log_id [Integer] The ID of the food log to edit
-    # @params body [Hash] The POST request body
+    # @param food_log_id [Integer] The ID of the food log to edit
+    # @param body [Hash] The POST request body
 
     def update_food_log(food_log_id, body)
       post("user/#{user_id}/foods/log/#{food_log_id}.json", body)
@@ -61,7 +61,7 @@ module FitbitAPI
 
     # Deletes a user's food log entry using the given log ID
     #
-    # @params food_log_id [Integer] The id of the food log entry
+    # @param food_log_id [Integer] The id of the food log entry
 
     def delete_food_log(food_log_id)
       delete("user/#{user_id}/foods/log/#{food_log_id}.json")
@@ -75,7 +75,7 @@ module FitbitAPI
 
     # Deletes a food with the given ID from the user's list of favorite foods
     #
-    # @params food_id [Integer] The ID of the food to delete from the user's favorites
+    # @param food_id [Integer] The ID of the food to delete from the user's favorites
 
     def delete_favorite_food(food_id)
       delete("user/#{user_id}/foods/log/favorite/#{food_id}.json")

data/lib/fitbit_api/meals.rb

@@ -8,7 +8,7 @@ module FitbitAPI
 
     # Retrieves a single meal created by the user from their food log given the meal id
     #
-    # @params meal_id [Integer] The ID of the meal
+    # @param meal_id [Integer] The ID of the meal
 
     def meal(meal_id)
       get("user/#{user_id}/meals/#{meal_id}.json")
@@ -16,7 +16,7 @@ module FitbitAPI
 
     # Creates a meal with the given food
     #
-    # @params body [Hash] The POST request body
+    # @param body [Hash] The POST request body
 
     def create_meal(body)
       post("user/#{user_id}/meals.json", body)
@@ -24,8 +24,8 @@ module FitbitAPI
 
     # Updates an existing meal with the contents of the request
     #
-    # @params meal_id [Integer] The ID of the meal
-    # @params body [Hash] The POST request body
+    # @param meal_id [Integer] The ID of the meal
+    # @param body [Hash] The POST request body
 
     def update_meal(meal_id, body)
       post("user/#{user_id}/meals/#{meal_id}.json", body)
@@ -33,7 +33,7 @@ module FitbitAPI
 
     # Deletes an existing meal of the given meal ID
     #
-    # @params meal_id [Integer] The ID of the meal
+    # @param meal_id [Integer] The ID of the meal
 
     def delete_meal(meal_id)
       delete("user/#{user_id}/meals/#{meal_id}.json")

data/lib/fitbit_api/sleep.rb

@@ -7,7 +7,7 @@ module FitbitAPI
     # periods that began on the previous date. For example, if you request a Sleep Log for 2021-12-22,
     # it may return a log entry that began the previous night on 2021-12-21, but ended on 2021-12-22.
     #
-    # @params date [Date, String] The date for the sleep log to be returned in the format yyyy-MM-dd
+    # @param date [Date, String] The date for the sleep log to be returned in the format yyyy-MM-dd
 
     def sleep_logs(date=Date.today)
       get("user/#{user_id}/sleep/date/#{format_date(date)}.json")

data/lib/fitbit_api/user.rb

@@ -14,7 +14,7 @@ module FitbitAPI
 
     # Modifies a user's profile data.
     #
-    # @params body [Hash] The POST request body
+    # @param body [Hash] The POST request body
 
     def update_profile(body)
       post("user/#{user_id}/profile.json", body)

data/lib/fitbit_api/version.rb

@@ -1,3 +1,3 @@
 module FitbitAPI
-  VERSION = '0.12.1'
+  VERSION = '0.12.2'
 end

data/lib/fitbit_api/water.rb

@@ -18,8 +18,8 @@ module FitbitAPI
 
     # Updates the quantity consumed for a user's water log entry with the given log ID
     #
-    # @params water_log_id [Integer] The ID of the water log to be updated
-    # @params body [Hash] The POST request body for updating the water log
+    # @param water_log_id [Integer] The ID of the water log to be updated
+    # @param body [Hash] The POST request body for updating the water log
 
     def update_water_log(water_log_id, body)
       post("user/#{user_id}/foods/log/water/#{water_log_id}.json", body)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fitbit_api
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 0.12.2
 platform: ruby
 authors:
 - Zoran