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

Add config docs #271

Merged
merged 6 commits into from
Jul 27, 2023
Merged

Add config docs #271

merged 6 commits into from
Jul 27, 2023

Conversation

phackstock
Copy link
Contributor

This PR adds documentation for the new nomenclature configuration feature.

@phackstock phackstock added the documentation Improvements or additions to documentation label Jul 27, 2023
@phackstock phackstock self-assigned this Jul 27, 2023
danielhuppmann
danielhuppmann reviewed Jul 27, 2023
View reviewed changes
Copy link
Member

@danielhuppmann danielhuppmann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few suggestions inline, and please also add the config file to the directory structure, see

nomenclature/docs/user_guide/directory-structure.rst

Line 23 in b4cbb53

└── ...

docs/user_guide.rst Show resolved Hide resolved
docs/user_guide/config.rst Outdated Show resolved Hide resolved
docs/user_guide/config.rst Outdated Show resolved Hide resolved
docs/user_guide/config.rst Outdated Show resolved Hide resolved
docs/user_guide/config.rst Outdated Show resolved Hide resolved
docs/user_guide/config.rst Show resolved Hide resolved
docs/user_guide/config.rst Outdated Show resolved Hide resolved
docs/user_guide/config.rst Outdated Show resolved Hide resolved
docs/user_guide/config.rst Outdated Show resolved Hide resolved
docs/user_guide/config.rst Outdated Show resolved Hide resolved
danielhuppmann
danielhuppmann approved these changes Jul 27, 2023
View reviewed changes
Copy link
Member

@danielhuppmann danielhuppmann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, a few final formatting and shortening suggestions, then good to merge and do a release!

docs/user_guide/config.rst Outdated Show resolved Hide resolved
docs/user_guide/config.rst Outdated Show resolved Hide resolved
docs/user_guide/config.rst Outdated Show resolved Hide resolved
docs/user_guide/config.rst Outdated Show resolved Hide resolved
docs/user_guide/config.rst Outdated Show resolved Hide resolved
@phackstock @danielhuppmann
Apply suggestions from code review
4458ad3 
Co-authored-by: Daniel Huppmann <dh@dergelbesalon.at>
@phackstock
Copy link
Contributor Author

Thanks for the corrections @danielhuppmann, I'll go ahead with the merge and the new release.

@phackstock phackstock merged commit 061d51a into IAMconsortium:main Jul 27, 2023
11 checks passed
@phackstock phackstock deleted the docs/add-nomenclature-config branch July 27, 2023 11:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@danielhuppmann danielhuppmann danielhuppmann approved these changes

Assignees

@phackstock phackstock

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@phackstock @danielhuppmann