Second PR to update the Nomenclature documentation #242
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
doc/source/api/codelist.rst
Outdated
| @@ -4,12 +4,12 @@ | |||
| ============ | |||
|
|
|||
| .. autoclass:: CodeList | |||
| :members: | |||
| :members: validate_items, from_directory, read_excel, to_yaml, to_pandas, to_csv, to_excel, codelist_repr, filter | |||
There was a problem hiding this comment.
Changing the order to a logical workflow (initialize, do, export) and removing an unnecessary method.
Suggested change
| :members: validate_items, from_directory, read_excel, to_yaml, to_pandas, to_csv, to_excel, codelist_repr, filter | |
| :members: from_directory, read_excel, validate_items, filter, to_yaml, to_pandas, to_csv, to_excel | |
There was a problem hiding this comment.
That makes a lot of sense! Sounds good.
danielhuppmann
approved these changes
May 5, 2023
phackstock
approved these changes
May 5, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hello! I took out what I thought were unnecessary methods listed in the documentation under API Documentation: CodeList and RegionProcessor (but let me know if I need to add back in some), and by doing this I was able to get rid of the table that had been there in previous versions.