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

Expand the docs of ScenarioInfo #148

Open
glatterf42 opened this issue Jan 22, 2024 · 0 comments
Open

Expand the docs of ScenarioInfo #148

glatterf42 opened this issue Jan 22, 2024 · 0 comments
Labels
doc Improvements or additions to documentation

Comments

@glatterf42
Copy link
Member

Should we leave a note somewhere that we strongly encourage users to still use the syntax you were trying to enforce?

We could in fact substantially expand the docs of ScenarioInfo with narrative explanation and examples of the many ways the class can be/is used in message-ix-models and message_data. For instance, see how doc/api/util.rst has extra content on how to use the Context class.

Whether to do that in this PR or another, I leave to you.

Originally posted by @khaeru in #146 (review)

@glatterf42 glatterf42 added the doc Improvements or additions to documentation label Jan 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant