-
-
Notifications
You must be signed in to change notification settings - Fork 26.2k
[MRG] insert versionadded versionchanged directives in docstrings for 0.18 #5856
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
@@ -28,6 +28,8 @@ | |||
|
|||
Note: this script does not check any of the dependent C libraries; it only | |||
operates on the Cython .pyx files. | |||
|
|||
.. versionadded:: 0.18 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think this is ever rendered / interpreted. It doesn't hurt either, though.
thank you, this is very helpful. The main comment is that for new files, each public class or function in the file needs a versionadded (or versionchanged if it was moved, as the ones in the model_selection module) |
comments addressed:
I wouldn't ordinarily squash mid-review, but it's tidier reading. |
@@ -30,15 +30,23 @@ class NotFittedError(ValueError, AttributeError): | |||
... print(repr(e)) | |||
... # doctest: +NORMALIZE_WHITESPACE +ELLIPSIS | |||
NotFittedError('This LinearSVC instance is not fitted yet',) | |||
|
|||
.. versionadded:: 0.18 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All the exceptions where actually all moved, but from different places...
Thanks for all the changes. This looks good. It might be nice to say where the exceptions came from, but I don't feel strongly about it. |
chased down the original exception class locations and noted in versionadded directives |
merged via #7403 |
issue #5505 versionadded/versionchanged directives for new stuff in 0.18.
It was not clear to me if I should also add these at the file/module level for new files (I did).