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

Use base class docstrings #45

Closed
mcgibbon opened this issue Jun 13, 2018 · 3 comments
Closed

Use base class docstrings #45

mcgibbon opened this issue Jun 13, 2018 · 3 comments
Milestone

Comments

@mcgibbon
Copy link
Member

mcgibbon commented Jun 13, 2018

Currently there are many component docstrings on __init__, __call__ or array_call methods which don't really say much of anything useful that the base class docstrings don't already say. For those components, we should remove the docstring entirely so that Sphinx will use the base class docstrings (which are written to be generic enough to apply to any component). The important part of the documentation is present in the *_properties dictionaries of the components.

We also could think about a way to include those property dictionaries in the documentation, but that's a separate issue.

@mcgibbon mcgibbon added this to the sympl-0.4.0 milestone Jun 13, 2018
@JoyMonteiro
Copy link
Member

In most components __init__ always has quite detailed docstring. I agree that we should eliminate docstrings for __call__ which don't really do much.

@mcgibbon
Copy link
Member Author

Yes, there are just a couple __init__ methods with no kwargs where I'll remove the docstring.

@mcgibbon
Copy link
Member Author

Fixed by #68

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

No branches or pull requests

2 participants