Move inputs documentation from sources.csv to inputs/*/README.md - #157
Draft
kennedy-mindermann wants to merge 15 commits into
Draft
Move inputs documentation from sources.csv to inputs/*/README.md#157kennedy-mindermann wants to merge 15 commits into
sources.csv to inputs/*/README.md#157kennedy-mindermann wants to merge 15 commits into
Conversation
… get deflator from input specific dollaryear files
| @@ -1,4 +1,4 @@ | |||
| # Model zone definitions | |||
| ## Model Zone Definitions | |||
Contributor
There was a problem hiding this comment.
I use the markdownlint extension and it complains if the first line in the file is not a top-level heading (single #). Is it ok to stick with that format?
Contributor
Author
There was a problem hiding this comment.
I think so, I had originally left them as single # but that prevents us from compiling into a single markdown file for the documentation unless we do some additional processing
Contributor
There was a problem hiding this comment.
Oh I see, thanks. I can just turn off that rule if it complicates things (I'm not sure how widely that linter is used anyway).
This file contains hidden or 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
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.
Summary
This PR adds more
inputs/*/README.mdfiles and automatically compiles them into a single Inputs Documentation page. I removed all of the input files insources.csvand added any information found there to the applicable README.md.Since the documentation on the inputs is still pretty light, I also created this issue to cover filling in the documentation a bit more with this new structure: #156.
Technical details
Implementation notes
Additional changes
Switches added/removed/changed
Issues resolved
Addresses the documentation reorganization mentioned in #43
Known incompatibilities
Relevant sources or documentation
Validation, testing, and comparison report(s)
Checklist for author
Details to double-check
hourlize/resource.pywas rerun to regenerate the existing/prescribed VRE capacity dataGeneral information to guide review
Did you use LLM tools (chatbot or copilot) in the preparation of this PR? If so, describe how
Yes, I used copilot to help me write the
generate_inputs_markdown.pyscript.