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.

Sign up for GitHub

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

Jump to bottom

Merge docstrings for __init__() and apply() in wrap_algorithm #25

Closed
jnhansen opened this issue Sep 10, 2019 · 0 comments · Fixed by #26
Closed

Merge docstrings for __init__() and apply() in wrap_algorithm #25

jnhansen opened this issue Sep 10, 2019 · 0 comments · Fixed by #26
Assignees
@jnhansen
Labels
docs Code documentation
Milestone
0.1

Comments

@jnhansen
Copy link
Owner

In nd.algorithm.wrap_algorithm(), need to combine docstrings from Algorithm.__init__ and Algorithm.apply, as follows:

  • parameters from apply should be prepended to the parameters of __init__
  • the return value should be taken from apply.
@jnhansen jnhansen added the docs Code documentation label Sep 10, 2019
@jnhansen jnhansen added this to the 0.1 milestone Sep 10, 2019
@jnhansen jnhansen self-assigned this Sep 10, 2019
@jnhansen jnhansen mentioned this issue Sep 10, 2019
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jnhansen jnhansen

Labels
docs Code documentation
Projects
None yet
Milestone
0.1
Development

Successfully merging a pull request may close this issue.

Improve automatic docstring generation for algorithm wrappers jnhansen/nd
1 participant
@jnhansen