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

Adding init Constructors to OpenMDAO Docs #1458

Merged
merged 9 commits into from Jun 15, 2020
Merged

Conversation

DKilkenny
Copy link
Contributor

Summary

Added __init__ constructor to CaseReader docs as well as all components, solvers, and drivers.

Related Issues

Backwards incompatibilities

None

New Dependencies

None

@project-bot project-bot bot added this to In progress in OpenMDAO Dev [Read only] Jun 10, 2020
OpenMDAO Dev [Read only] automation moved this from In progress to Reviewer approved Jun 11, 2020
Copy link
Contributor

@robfalck robfalck left a comment

Choose a reason for hiding this comment

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

Short of rewriting our doc scripts to merge options and init args, I like this approach. init isn't necessary to document in a lot of cases, but better to be extra verbose than not verbose enough.

Approved pendings the changes requested by Steve.

@swryan swryan merged commit 42cfaf5 into OpenMDAO:master Jun 15, 2020
OpenMDAO Dev [Read only] automation moved this from Reviewer approved to Done Jun 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

CaseReader pre_load argument is not documented.
4 participants