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 of common region vs. model-native region #145

Closed
danielhuppmann opened this issue Aug 10, 2022 · 3 comments · Fixed by #161
Closed

Documentation of common region vs. model-native region #145

danielhuppmann opened this issue Aug 10, 2022 · 3 comments · Fixed by #161
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@danielhuppmann
Copy link
Member

Per this comment by @luciecastella in #144 (comment)_, it would be useful to have an own section explaining the difference between a "common" region vs. a "model_native" region. Could be an own new sub-page of the user guide or in the Region section of the "codelist" page.

@danielhuppmann danielhuppmann added the documentation Improvements or additions to documentation label Aug 10, 2022
@danielhuppmann
Copy link
Member Author

Looking at the docs again, I think pulling our the "variable" and "region" sections from codelist.rst to own pages (and only keep the generic info on that page, plus links to the detailed pages for the more complex dimensions) is the best approach...

@phackstock
Copy link
Contributor

That is what you have implemented in #140 right (minus the links on the codelist.rst to "variable" and "region")? It's just not in the "stable" part of the docs yet since it's not part of the latest release. In the "latest" version (https://nomenclature-iamc.readthedocs.io/en/latest/user_guide.html) we have that split. Maybe we should think about another release once #144 is merged.

@danielhuppmann
Copy link
Member Author

Right, I just looked at the default (stable) docs page on RTD. Good to know that at least my thinking is consistent over time... 😜

And yes, @luciecastella, up to you to do a release after tackling #144!

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.

3 participants