-
-
Notifications
You must be signed in to change notification settings - Fork 19.2k
DOC: add whatsnew note about __module__ changes for the public API #62784
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
DOC: add whatsnew note about __module__ changes for the public API #62784
Conversation
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.
lgtm
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.
Only issue for me is using the word "object" to refer to both a function and a class. I suggested using "member" instead. Not sure if there is a better word
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| The ``__module__`` attribute on functions and classes in the public API has been | ||
| updated to refer to the preferred public module from which to access the object, |
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.
| updated to refer to the preferred public module from which to access the object, | |
| updated to refer to the preferred public module from which to access the member of the API, |
I don't think using "object" here makes sense in referring to "function"
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.
From the "everything in Python in an object", I think this makes sense.
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.
Hadn't heard that statement before. But it makes sense. I'll leave it up to Joris if he wants to change it.
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.
Also good with object. This statement also applies to class instances (e.g. pd.NA).
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.
Yeah, I wanted to avoid repeating "function or class".
Will leave it as is then
|
|
||
| The ``__module__`` attribute on functions and classes in the public API has been | ||
| updated to refer to the preferred public module from which to access the object, | ||
| rather than the module in which the object happens to be defined (:issue:`55178`). |
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.
| rather than the module in which the object happens to be defined (:issue:`55178`). | |
| rather than the module in which the member happens to be defined (:issue:`55178`). |
To finish the work of #55178, adding a whatsnew note about this