Skip to content

Commit 2fa62bf

Browse files
authored
Merge pull request #304 from sash20m/docs-improvement
Get Energy Doc Fixes
2 parents 9d5efe2 + 0913ec1 commit 2fa62bf

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

docs/getActiveEnergyBurned.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
# getActiveEnergyBurned
22

3-
A quantity sample type that measures the amount of active energy the user has burned.
3+
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.
44

55
Example input options:
66

77
```javascript
88
let options = {
99
startDate: new Date(2021, 0, 0).toISOString(), // required
1010
endDate: new Date().toISOString(), // optional; default now
11+
ascending: true, // optional
12+
includeManuallyAdded: true, // optional
1113
}
1214
```
1315

docs/getBasalEnergyBurned.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
11
# getBasalEnergyBurned
22

3-
A quantity sample type that measures the amount of energy burned.
3+
A quantity sample type that measures the amount of `resting energy` burned within a period of time.
4+
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).
45

56
Example input options:
67

78
```javascript
89
let options = {
910
startDate: new Date(2018, 10, 1).toISOString(), // required
1011
endDate: new Date().toISOString(), // optional; default now
12+
ascending: true, // optional
13+
includeManuallyAdded: true, // optional
1114
}
1215
```
1316

0 commit comments

Comments
 (0)