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

Document how to access methods within specific model classes #64

Open
fershad opened this issue Sep 4, 2024 · 1 comment
Open

Document how to access methods within specific model classes #64

fershad opened this issue Sep 4, 2024 · 1 comment

Comments

@fershad
Copy link
Collaborator

fershad commented Sep 4, 2024

Is your feature request related to a problem? Please describe.

CO2.js v0.16 introduced the ability to access methods that were previously private within a given model class. This was applied in PR thegreenwebfoundation/co2.js#220.

These methods could be used by developers to do more than just estimate carbon emissions - allowing them to expose information about estimated energy use, operational v. embodied emissions, and more.

However, there's no documentation for these methods.

Describe the solution you'd like

These private methods should be documented on the Methods page in the CO2.js section of the docs website.

The methods to be document are:

Sustainable Web Design v4

Sustainable Web Design v3

Describe alternatives you've considered
We've tried to expose these via alternate tooling like JSR, however that's no possible without a rewrite of the library to TypeScript which is something we're not in a position to steward at this time.

@fershad
Copy link
Collaborator Author

fershad commented Sep 4, 2024

Rather than dumping this into one huge PR, these changes can be split into two separate PRs (one for v3, one for v4)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant