FIX-#7263: Empty docstrings should not be inherited #7264
Conversation
Signed-off-by: Anatoly Myachev <anatoly.myachev@intel.com>
anmyachev
requested review from
devin-petersohn,
mvashishtha,
RehanSD,
YarShev,
vnlitvinov,
dchigarev and
a team
as code owners
| @@ -434,6 +437,7 @@ def _documentable_obj(obj: object) -> bool: | |||
| """Check if `obj` docstring could be patched.""" | |||
| return bool( | |||
| callable(obj) | |||
There was a problem hiding this comment.
Classes are also callable, but we should not modify them. An important clarification - this only applies to classes that can be stored in the attributes of the class for which we are inheriting docstrings.
| @@ -239,12 +239,12 @@ def wait(self): | |||
| DaskWrapper.wait(self.list_of_blocks) | |||
|
|
|||
|
|
|||
| @_inherit_docstrings(PandasOnDaskDataframeVirtualPartition.__init__) | |||
| @_inherit_docstrings(PandasOnDaskDataframeVirtualPartition) | |||
There was a problem hiding this comment.
Inheriting a docstring from a method for an entire class does not seem correct.
| @@ -1118,7 +1118,7 @@ def merge_asof( | |||
| tolerance=None, | |||
| allow_exact_matches: bool = True, | |||
| direction: str = "backward", | |||
| ): | |||
| ): # noqa: GL08 | |||
There was a problem hiding this comment.
Previously, an empty string was assigned and the problem was not visible.
Now the question arises: why did the checker not pay attention to the empty string? This is most likely another bug :) In this situation, the successor does not override this function (PandasQueryCompiler.merge_asof is BaseQueryCompiler.merge_asof == True), it turns out that we inherit an empty string and assign __doc_inherited__ label. And since the function is the same, we essentially disabled the check not only for the function that is docstring inherited, but also the function from which we took it.
There was a problem hiding this comment.
Thanks for the explanation :)
What do these changes do?
flake8 modin/ asv_bench/benchmarks scripts/doc_checker.pyblack --check modin/ asv_bench/benchmarks scripts/doc_checker.pygit commit -sadded andpassingdocs/development/architecture.rstis up-to-date