Skip to content

Commit 2b384db

Browse files
authored
chore: clarify the definition of dataReloadRatio
2 parents 23c2e39 + 709d80b commit 2b384db

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

src/docs/co2js/methods.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ The `perVisitTrace()` function accepts the following parameters:
134134

135135
The `options` parameter can contain any of the following keys. These can be used to adjust the values used by the Sustainable Web Design Model's calculation.
136136

137-
- `dataReloadRatio` <span class="badge align-middle badge-success my-0">Optional</span> – a `number` between 0 and 1 representing the percentage of data that is downloaded by return visitors.
137+
- `dataReloadRatio` <span class="badge align-middle badge-success my-0">Optional</span> – a `number` between 0 and 1 representing the percentage of data that is downloaded by return visitors. This is the complement of the data cache ratio from the Sustainable Web Design model, i.e. dataReloadRatio = 1 - dataCacheRatio.
138138
- `firstVisitPercentage` <span class="badge align-middle badge-success my-0">Optional</span> – a `number` between 0 and 1 representing the percentage of new visitors.
139139
- `returnVisitPercentage` <span class="badge align-middle badge-success my-0">Optional</span> – a `number` between 0 and 1 representing the percentage of returning visitors.
140140
- `greenHostingFactor` <div class="badge badge-warning gap-2 align-middle">Sustainable Web Design Model v4 only</div> - The portion of hosting services powered by renewable or zero-carbon energy, between 0 and 1. If the `green hosting` boolean above is set to `true` then the `greenHostingFactor` will always be `1`.
@@ -173,6 +173,6 @@ The `perVisitTrace()` function returns an object with the following keys:
173173
- `dataCenter` – A `number` representing the carbon intensity for this segment (in grams per kilowatt-hour) used in the calculation.
174174
- `networks` – A `number` representing the carbon intensity for this segment (in grams per kilowatt-hour) used in the calculation.
175175
- `production` - A `number` representing the carbon intensity for this segment (in grams per kilowatt-hour) used in the calculation.
176-
- `dataReloadRatio` – a `number` between 0 and 1 representing the percentage of data that is downloaded by return visitors.
176+
- `dataReloadRatio` – a `number` between 0 and 1 representing the percentage of data that is downloaded by return visitors. This is the complement of the data cache ratio from the Sustainable Web Design model, i.e. dataReloadRatio = 1 - dataCacheRatio.
177177
- `firstVisitPercentage` – a `number` between 0 and 1 representing the percentage of new visitors.
178178
- `returnVisitPercentage` – a `number` between 0 and 1 representing the percentage of returning visitors.

0 commit comments

Comments
 (0)