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

Update yaml schema #107

Merged
merged 15 commits into from
Jul 7, 2023
Merged

Update yaml schema #107

merged 15 commits into from
Jul 7, 2023

Conversation

eyoung55
Copy link
Collaborator

@eyoung55 eyoung55 commented Jun 29, 2023

Purpose

Add better explanations to the top-level categories in the yaml schema, add units to each option, and generally clean up the descriptions before the final tagging.

Type of change

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (non-backwards-compatible fix or feature)
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no API changes)
  • Documentation update
  • Maintenance update
  • Other (please describe)

Testing

docs built locally and passing

Checklist

Put an x in the boxes that apply.

  • I have run existing tests which pass locally with my changes
  • I have added new tests or examples that prove my fix is effective or that my feature works
  • I have added necessary documentation

@eyoung55
Copy link
Collaborator Author

eyoung55 commented Jun 29, 2023

TODO:

  • clean up descriptions
  • add top-level descriptions to general, domain, etc.

@eyoung55 eyoung55 merged commit 26d6408 into NREL:dev Jul 7, 2023
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants