Let's say some method of a parent class is reimplemented in a child class.
This child method is intended to do the same that the parent method, with a minor change.
In this case, in the documentation of the child method, is it useful to cover what the parent method do ?
If we do, the child method is 'self-supporting' but the parent method can be changed and the child doc becomes outdated, or even false
If we don't, we have to navigate from child to parents to get the full-picture, which can be annoying
class Parent: def some_method(self): """ This method does A and B """ class Child(Parent): def some_method(self): """ This method also does extra C """
Apart from your opinions and preferences (that I would love to hear), do we have 'canonical' sources such as reputable books about this question ?
Edit: I see that by including dumb implementation in the examples above, I made the question confuse by letting think that the documentation was about the implementation details. It is not, so let's remove the implementation. I think the problem still stands with its pros and cons (doc duplication being potentially harmful as code duplication vs. self supporting doc)