Skip to content

Docstring inheritance #241

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

Closed
chkoar opened this issue Mar 12, 2017 · 4 comments
Closed

Docstring inheritance #241

chkoar opened this issue Mar 12, 2017 · 4 comments
Labels
For: Documentation Indicates a need for improvements or additions to documentation

Comments

@chkoar
Copy link
Member

chkoar commented Mar 12, 2017

I think that we can eliminate many lines of docstrings by inherit the docstring from a parent class.
A possible way is to use a decorator like in https://groups.google.com/forum/#!msg/comp.lang.python/HkB1uhDcvdk/lWzWtPy09yYJ

@glemaitre
Copy link
Member

glemaitre commented Mar 12, 2017 via email

@glemaitre
Copy link
Member

Thinking about it, I really think that this is easy to code or
contribute when the docstring is present at the lowest level. If you
need to check the doc or to go and find the base class, it starts to be
complicated even if it removes a lot of lines.

@glemaitre glemaitre added the For: Documentation Indicates a need for improvements or additions to documentation label Mar 22, 2017
@glemaitre
Copy link
Member

I think that we should still have the docstring on the lower level whenever possible since it helps when reading the code itself.

@chkoar
Copy link
Member Author

chkoar commented Aug 3, 2017

Ok.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
For: Documentation Indicates a need for improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants