Merge pull request #304 from sash20m/docs-improvement

Get Energy Doc Fixes
agencyenterprise · Jul 3, 2023 · 2fa62bf · 2fa62bf
2 parents 9d5efe2 + 0913ec1
commit 2fa62bf
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. This represents only the Active Kilocalories from the Total Kilocalories for that time period.
 
 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 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 a 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
 }
 ```