More docstrings - #33
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR focuses on improving developer/user-facing documentation by expanding docstrings across the lyopronto simulation/optimization modules and revising README usage guidance.
Changes:
- Added/expanded docstrings for several simulation, design-space, and optimization entrypoints.
- Reworked README “How to Use This Code Directly” guidance and preserved the legacy CLI-based workflow description.
- Cleaned up
main.pyby removing stale commented-out imports.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 10 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Updates direct-usage guidance and adds legacy “original method” run instructions. |
| main.py | Removes commented import block (cleanup only). |
| lyopronto/opt_Tsh.py | Adds a dry() docstring describing the optimization output/inputs. |
| lyopronto/opt_Pch.py | Adds a dry() docstring describing the optimization output/inputs. |
| lyopronto/opt_Pch_Tsh.py | Adds a dry() docstring describing the joint optimization output/inputs. |
| lyopronto/high_level.py | Expands execute_simulation() docstring (args/returns/raises). |
| lyopronto/freezing.py | Adds a freeze() docstring. |
| lyopronto/design_space.py | Replaces placeholder arg docs with more specific descriptions. |
| lyopronto/calc_unknownRp.py | Adds a dry() docstring describing unknown-Rp workflow. |
| lyopronto/calc_knownRp.py | Makes arg documentation more specific for known-Rp workflow. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
No description provided.