Skip to content

Commit de988b0

Browse files
authored
docs(casdk): make documentation signal agnostic
1 parent a9412ac commit de988b0

File tree

2 files changed

+14
-15
lines changed

2 files changed

+14
-15
lines changed

casdk-docs/docs/tutorial-extras/carbon-aware-library.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Carbon Aware Library
22

3-
The Carbon Aware SDK provides a C\# Client Library to get the marginal carbon
3+
The Carbon Aware SDK provides a C\# Client Library to get the carbon
44
intensity for a given location and time period. The values reported in the Green
5-
Software Foundation's specification for marginal carbon intensity (Grams per
5+
Software Foundation's specification for carbon intensity (Grams per
66
Kilowatt Hour).
77

88
**_Recommended_** - This user interface is best for when you need a consumable
@@ -247,8 +247,7 @@ var data = await this._emissionsHandler.GetAverageCarbonIntensityAsync(
247247
);
248248
```
249249

250-
The response is a single double value representing the calculated average
251-
marginal carbon intensity g/kWh.
250+
The response is a single double value representing the calculated average carbon intensity g/kWh.
252251

253252
```csharp
254253
345.434
@@ -269,11 +268,11 @@ This function fetches only the most recently generated forecast for all provided
269268
locations. It uses the "dataStartAt" and "dataEndAt" parameters to scope the
270269
forecasted data points (if available for those times). If no start or end time
271270
boundaries are provided, the entire forecast dataset is used. The scoped data
272-
points are used to calculate average marginal carbon intensities of the
273-
specified "windowSize" and the optimal marginal carbon intensity window is
271+
points are used to calculate average carbon intensities of the
272+
specified "windowSize" and the optimal carbon intensity window is
274273
identified.
275274

276-
The forecast data represents what the data source predicts future marginal
275+
The forecast data represents what the data source predicts future
277276
carbon intensity values to be, not actual measured emissions data (as future
278277
values cannot be known).
279278

@@ -292,7 +291,7 @@ Parameters:
292291
current forecast data points after this time. Must be within the forecast
293292
data point timestamps. Defaults to the latest time in the forecast data. If
294293
neither `dataStartAt` nor `dataEndAt` are provided, all forecasted data
295-
points are used in calculating the optimal marginal carbon intensity window.
294+
points are used in calculating the optimal carbon intensity window.
296295
4. `windowSize`: The estimated duration (in minutes) of the workload. Defaults
297296
to the duration of a single forecast data point.
298297

@@ -306,7 +305,7 @@ var data = await this._forecastHandler.GetCurrentForecastAsync(
306305
```
307306

308307
The response is an array of `EmissionsForecast` objects (one per requested
309-
location) with their optimal marginal carbon intensity windows.
308+
location) with their optimal carbon intensity windows.
310309

311310
```csharp
312311
[
@@ -347,7 +346,7 @@ location) with their optimal marginal carbon intensity windows.
347346
### GetForecastByDateAsync
348347

349348
This function takes a requests for historical forecast data, fetches it, and
350-
calculates the optimal marginal carbon intensity window. This endpoint is useful
349+
calculates the optimal carbon intensity window. This endpoint is useful
351350
for back-testing what one might have done in the past, if they had access to the
352351
current forecast at the time.
353352

@@ -367,7 +366,7 @@ Parameters:
367366
to the duration of a single forecast data point
368367

369368
If neither `dataStartAt` nor `dataEndAt` are provided, all forecasted data
370-
points are used in calculating the optimal marginal carbon intensity window.
369+
points are used in calculating the optimal carbon intensity window.
371370

372371
```csharp
373372
var data = await this._forecastHandler.GetForecastByDateAsync(
@@ -379,7 +378,7 @@ var data = await this._forecastHandler.GetForecastByDateAsync(
379378
);
380379
```
381380

382-
The response is an `EmissionsForecast` object with the optimal marginal carbon
381+
The response is an `EmissionsForecast` object with the optimal carbon
383382
intensity window.
384383

385384
```csharp

src/GSF.CarbonAware/src/Handlers/IForecastHandler.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ namespace GSF.CarbonAware.Handlers;
55
public interface IForecastHandler
66
{
77
/// <summary>
8-
/// Retrieves the most recent forecasted data and calculates the optimal marginal carbon intensity window.
8+
/// Retrieves the most recent forecasted data and calculates the optimal carbon intensity window.
99
/// </summary>
1010
/// <param name="locations">Array of locations where the workflow is run (ex: ["eastus", "westus"])</param>
1111
/// <param name="dataStartAt">Start time boundary of forecasted data points. Ignores current forecast data points before this time (ex: 2022-03-01T15:30:00Z)</param>
@@ -15,13 +15,13 @@ public interface IForecastHandler
1515
Task<IEnumerable<EmissionsForecast>> GetCurrentForecastAsync(string[] locations, DateTimeOffset? dataStartAt = null, DateTimeOffset? dataEndAt = null, int? windowSize = null);
1616

1717
/// <summary>
18-
/// Retrieves the historical forecasted data for the given date range and calculates the optimal marginal carbon intensity window.
18+
/// Retrieves the historical forecasted data for the given date range and calculates the optimal carbon intensity window.
1919
/// </summary>
2020
/// <param name="location">String location where the workflow is run (ex: "eastus")</param>
2121
/// <param name="dataStartAt">Start time boundary of forecasted data points. Ignores current forecast data points before this time (ex: 2022-03-01T15:30:00Z)</param>
2222
/// <param name="dataEndAt">End time boundary of forecasted data points. Ignores current forecast data points after this time (ex: 2022-03-01T18:30:00Z)</param>
2323
/// <param name="requestedAt">The timestamp used to access the most recently generated forecast as of that time. (ex: 2022-03-01T18:30:00Z)</param>
2424
/// <param name="windowSize">The estimated duration (in minutes) of the workload.</param>
25-
/// <returns>An <see cref="EmissionsForecast"/> with the optimal marginal carbon intensity window.</returns>
25+
/// <returns>An <see cref="EmissionsForecast"/> with the optimal carbon intensity window.</returns>
2626
Task<EmissionsForecast> GetForecastByDateAsync(string location, DateTimeOffset? dataStartAt = null, DateTimeOffset? dataEndAt = null, DateTimeOffset? requestedAt = null, int? windowSize = null);
2727
}

0 commit comments

Comments
 (0)