DOC Add information regarding docstring when deprecating of parameters. #8904
Comments
|
The second variant should probably be preferred, if only because it is more
apparent to users what has happened, and perhaps to enable automatic
docstring checking
…On 20 May 2017 1:20 am, "Guillaume Lemaitre" ***@***.***> wrote:
In the documentation
<http://scikit-learn.org/dev/developers/contributing.html#deprecation>,
there is no mention of what have to be done with the docstring a deprecated
parameter.
However, I could not find clearly what is the way. I saw two patterns:
- Simply remove the docstring.
- Make a note that the parameter has been deprecated with the
information related to the versions.
In the last version (0.19), every deprecation used the first variant.
@jnothman <https://github.com/jnothman> @GaelVaroquaux
<https://github.com/gaelvaroquaux> @amueller <https://github.com/amueller>
Could you confirm which variant shall we used such that the documentation
can be updated accordingly.
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#8904>, or mute the
thread
<https://github.com/notifications/unsubscribe-auth/AAEz6yrxAgV6K7OsdsyR6iyOkN6gZ0wzks5r7bM7gaJpZM4NgqeP>
.
|
This was referenced May 20, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
In the documentation, there is no mention of what have to be done with the docstring a deprecated parameter.
However, I could not find clearly what is the way. I saw two patterns:
In the last version (0.19), every deprecation used the first variant.
@jnothman @GaelVaroquaux @amueller Could you confirm which variant shall we used such that the documentation can be updated accordingly.
The text was updated successfully, but these errors were encountered: