Improve various docstrings#1171
Merged
misi9170 merged 15 commits intoNatLabRockies:developfrom Jan 27, 2026
Merged
Conversation
Collaborator
|
Hey @misi9170 I have a few things to add along these lines, if you don't mind waiting a few days for me to submit a PR to your branch |
Collaborator
Author
|
@rafmudaf please do, no rush. Fine also for you to simply commit and push into my branch if you'd like. |
Collaborator
Author
|
Converting to draft while I'm still planning to address a couple of things:
|
Collaborator
Author
Collaborator
Author
|
@paulf81 , I've added you as a reviewer; hopefully, that's ok. Can you take a closer look at the documentation I've added for Serial Refine and then a quick pass over the rest? |
This was referenced Jan 27, 2026
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.
This PR makes a handful of updates to docstrings throughout FLORIS to respond to minor issues that have been raised.
FlorisModel.get_defaults()FlorisModel.get_defaults()missing docstring #1161floris.simulation(nowfloris.core) Documentation still refers to floris.simulation #1105 . In this case, I opted to remove a description of the floris input file structure and referred readers to the docs and the default_inputs.yaml for an example.rtor_squaredin Gaussian models (see A question about the setting of 'n' in the gaussian_function(C, r, n, sigma). #1102).