-
Notifications
You must be signed in to change notification settings - Fork 2
ReadTheDocs autoapi fixes #70
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
|
Found the fix for the parameter/docstring issue. Need to make sure we're distinguishing between attributes and args for classes. My fault for not being careful about that. Good news is that this will fix a problem that I might not have found without this issue! Bad news is I need to go through all classes and apply the fix. Will update as soon as that's done. |
…ould improve documentation for class attributes or just make them non-public since user shouldn't need them
…se since we now produce xarray objects which have that information (used to save values in the data generator object instead)
…sh between constructor args and attributes assigned based on those args (and 'locations' and 'times' which can be both)
…sing method names. Wait for its own PR
…Google style guide
…s to match Google style guide
|
@StevePny This is ready for review. Solves #69. You can preview the API reference docs here: https://dataassimbench.readthedocs.io/en/docs-rtd-autoapi-fixes/autoapi/dabench/index.html I focused on docs updates so as not to change functionality in this PR, but there's some outstanding items with open issues #51 and #71 |
Fixes for #69
Preview the new docs here: https://dataassimbench.readthedocs.io/en/docs-rtd-autoapi-fixes/autoapi/dabench/index.html
Will change to non-draft once I've checked through everything for consistency and looked into the parameter/docstring split problem mentioned above.