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

Add docstring to ConfigurableInstance. #27

Merged
merged 1 commit into from Sep 21, 2018
Merged

Add docstring to ConfigurableInstance. #27

merged 1 commit into from Sep 21, 2018

Conversation

ktlim
Copy link
Contributor

@ktlim ktlim commented Sep 18, 2018

Also fix a couple of minor other docstring problems, but not yet conforming to numpydoc standards.


Use the `value` property to access the actual Config instance; use the
target` property to access the associated configurable object (e.g. a
`Task`).
Copy link
Member

Choose a reason for hiding this comment

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

Should that be something like

`~lsst.pipe.tasks.Task`

?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, probably, as well as doing something for Config.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

And I lost a backtick before target in my pasting.

Also fix a couple of minor other docstring problems, but not yet conforming to numpydoc standards.
@ktlim ktlim merged commit d0f1235 into master Sep 21, 2018
@ktlim ktlim deleted the tickets/DM-15758 branch September 21, 2018 14:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants