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.

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

Documentation: Update wording about marginal signal #612

Open
1 task done
jbdietrich opened this issue Feb 3, 2025 · 1 comment · May be fixed by #614
Open
1 task done

Documentation: Update wording about marginal signal #612

jbdietrich opened this issue Feb 3, 2025 · 1 comment · May be fixed by #614
Labels
documentation Improvements or additions to documentation

Comments

@jbdietrich
Copy link

jbdietrich commented Feb 3, 2025

Contact Details

[email protected]

Overview of Change

The current version of the Carbon Aware SDK documentation refers to "marginal" or "average marginal" carbon intensity (see this page for examples).

Image

However, the Electricity Maps API does not provide the marginal signal. Therefore we propose removing the word marginal from the documentation for data that may be served by Electricity Maps to make it clearer that the underlying carbon intensity signal may be marginal or average.

Code of Conduct

  • I agree to follow this project's Code of Conduct
@jbdietrich jbdietrich added the documentation Improvements or additions to documentation label Feb 3, 2025
@danuw
Copy link
Collaborator

danuw commented Feb 3, 2025

Thank you, that is indeed legacy from pre Electricity Map (and was already pointed out to us in the past in another area). Well spotted.

@unitrium unitrium linked a pull request Feb 4, 2025 that will close this issue
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants