dianna
dianna copied to clipboard
Improve docstring policy
Right now, in #74, docstrings were introduced that fulfill all the technical requirements from linting. However, these requirements in some cases do not yield satisfactory results. For instance, methods.LIME.init lists self-descriptive argument names with types that are forwarded as is to LIME classes, where they are already well documented. The argument descriptions in our init function are superfluous. It would be better if we could just forward to the existing documentation, but the linter does not let us (at least not with the current documentation style).
If we add type hints, the argument list would become even more useless (except for the arguments unique to our class of course, i.e. the ones that aren't just blindly forwarded to the method).
How can we improve our docstrings?