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

Updating GreenHEART Examples #30

Merged
merged 17 commits into from
Oct 25, 2024
Merged

Updating GreenHEART Examples #30

merged 17 commits into from
Oct 25, 2024

Conversation

kbrunik
Copy link
Collaborator

@kbrunik kbrunik commented Oct 25, 2024

Clean up GreenHEART Examples

Related issue

Impacted areas of the software

Additional supporting information

Test results, if applicable

@kbrunik kbrunik added documentation Improvements or additions to documentation code cleanup labels Oct 25, 2024
@kbrunik kbrunik requested a review from johnjasa October 25, 2024 19:06
@kbrunik kbrunik added this to the v0.1.0 milestone Oct 25, 2024
Copy link
Collaborator

@johnjasa johnjasa left a comment

Choose a reason for hiding this comment

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

Looks great, I pushed some extremely minor changes directly to the PR.

All four of the example notebooks have some quasi-repetitive explanations in the first half of the notebooks. Is this on purpose for repetition, or is each notebook supposed to stand on its own? In the future for docs I'd suggest removing redundancies if not needed, but that's a later consideration.

@kbrunik
Copy link
Collaborator Author

kbrunik commented Oct 25, 2024

Looks great, I pushed some extremely minor changes directly to the PR.

All four of the example notebooks have some quasi-repetitive explanations in the first half of the notebooks. Is this on purpose for repetition, or is each notebook supposed to stand on its own? In the future for docs I'd suggest removing redundancies if not needed, but that's a later consideration.

Yeah there's definitely some repetition, would love to have a large discussion about how the examples should work i.e. if they should be stand-alone or not. I feel 50/50 on it myself.

@johnjasa johnjasa merged commit 5991cf0 into NREL:develop Oct 25, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code cleanup documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants