docs fix

agencyenterprise · Mar 27, 2023 · 3d0fe4a · 3d0fe4a
1 parent 03a20fa
commit 3d0fe4a
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/docs/getActiveEnergyBurned.md b/docs/getActiveEnergyBurned.md
@@ -1,13 +1,15 @@
 # getActiveEnergyBurned
 
-A quantity sample type that measures the amount of active energy the user has burned.
+A quantity sample type that measures the amount of `active energy` the user has burned within a period of time.
 
 Example input options:
 
 ```javascript
 let options = {
   startDate: new Date(2021, 0, 0).toISOString(), // required
   endDate: new Date().toISOString(), // optional; default now
+  ascending: true, // optional
+  includeManuallyAdded: true, // optional
 }
 ```
 

diff --git a/docs/getBasalEnergyBurned.md b/docs/getBasalEnergyBurned.md
@@ -1,13 +1,16 @@
 # getBasalEnergyBurned
 
-A quantity sample type that measures the amount of energy burned.
+A quantity sample type that measures the amount of `resting energy` burned for within a period of time.
+These samples together with active energy burned for the same time period represent the `total energy` burned for that period (usually seen as Total Kilocalories in workout on Apple Watch).
 
 Example input options:
 
 ```javascript
 let options = {
   startDate: new Date(2018, 10, 1).toISOString(), // required
   endDate: new Date().toISOString(), // optional; default now
+  ascending: true, // optional
+  includeManuallyAdded: true, // optional
 }
 ```