You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I was wondering if we can merge docstring of different kinds.
"""This is a test."""importsklearnimportnumpyfromtypingimportOptionalfromcustom_inheritimportdoc_inheritclassMyDecisionTreeClassifier(sklearn.tree.DecisionTreeClassifier):
@doc_inherit(sklearn.tree.DecisionTreeClassifier.predict_proba, style="google_with_merge")defpredict_proba(
self,
X: numpy.ndarray,
check_input: Optional[bool] =True,
my_option: Optional[bool] =False,
) ->numpy.ndarray:
"""Predict class probabilities of the input samples X. Args: my_option: If True, this is happening. If False, this other thing is happening and I need two lines to explain this option. Returns: numpy.ndarray: the result """print(my_option)
super.predict_proba(X, check_input=check_input)
Here, I'd like to merge scikit docstring (which is numpy) with mine (which is google). It more or less works already:
but you can see that there is a bad thing happening because my_option explanation is too long. More precisely, it cuts the line in two, and writes "option. (need two lines to explain this) –" as a fake new option.
I wonder if it can be fixed easily. If not, it is already a great tool thanks
The text was updated successfully, but these errors were encountered:
Hey. Great tool, thanks a lot!
I was wondering if we can merge docstring of different kinds.
Here, I'd like to merge scikit docstring (which is numpy) with mine (which is google). It more or less works already:
but you can see that there is a bad thing happening because
my_option
explanation is too long. More precisely, it cuts the line in two, and writes "option. (need two lines to explain this) –" as a fake new option.I wonder if it can be fixed easily. If not, it is already a great tool thanks
The text was updated successfully, but these errors were encountered: