Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Make documentation for forecasts signal agnostic #614

Open
wants to merge 3 commits into
base: dev
Choose a base branch
from
Open

Make documentation for forecasts signal agnostic #614

wants to merge 3 commits into from
+40 −41

Conversation

unitrium
Copy link

@unitrium unitrium commented Feb 4, 2025

Pull Request

Issue Number: Link to Github Issue or Azure Dev Ops Task/Story)

Summary

Make the documentation for forecasts, signal agnostic.

Changes

  • In the carbon aware sdk documentation, remove the mention of marginal as if you use ElectricityMaps' signals, the signals you will get are not marginal forecasts but average carbon intensity. To avoid any confusion, making the documentation signal agnostic.
  • Update the carbon aware API documentation accordingly.

Checklist

  • Local Tests Passing?
  • CICD and Pipeline Tests Passing?
  • Added any new Tests?
  • Documentation Updates Made?
  • Are there any API Changes? If yes, please describe below.
  • This is not a breaking change. If it is, please describe it below.

Are there API Changes?

If yes, what are the expected API Changes? Please link to an API-Comparison
workflow with the API Diff.

Is this a breaking change?

No.

Anything else?

Please follow
GitHub's suggested syntax
to link Pull Requests to Issues via keywords

This PR Closes #612

@unitrium
DCO Remediation Commit for Robin TROESCH <[email protected]…
69254e0 
…eply.github.com>

I, Robin TROESCH <[email protected]>, hereby add my Signed-off-by to this commit: de988b0
I, Robin TROESCH <[email protected]>, hereby add my Signed-off-by to this commit: 137cd72

Signed-off-by: Robin TROESCH <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vaughanknight vaughanknight Awaiting requested review from vaughanknight vaughanknight is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Documentation: Update wording about marginal signal
1 participant
@unitrium