-
Notifications
You must be signed in to change notification settings - Fork 182
Improve various docstrings #1171
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
Conversation
|
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 |
|
@rafmudaf please do, no rush. Fine also for you to simply commit and push into my branch if you'd like. |
|
Converting to draft while I'm still planning to address a couple of things:
|
|
@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? |
paulf81
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All changes look good to me, thanks! @misi9170
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).