DOC: Set __module__ attributes and remove core from documentation
#62727
Conversation
| """ | ||
|
|
||
| __module__ = "pandas" | ||
| __module__ = "pandas.api.typing" |
There was a problem hiding this comment.
I get wanting NatType in the api,typing namespace, but do t we want pd.NaT in the pandas namespace? Same for pd.NA above
There was a problem hiding this comment.
Ack, I didn't realize we'd also need to consider __module__ on class instances. Thanks.
rhshadrach
changed the title
core from documentation
rhshadrach
changed the title
core from documentationcore from documentation
pandas/tests/api/test_api.py
Outdated
| or ("Dtype" in name and obj.__module__ == "pandas") | ||
| or (name == "Categorical" and obj.__module__ == "pandas") | ||
| # TODO: Can't seem to change __module__ | ||
| or name == "Interval" |
There was a problem hiding this comment.
Modifying __module__ on Interval doesn't seem to have an impact; I'm guessing because this is a cdef class?
There was a problem hiding this comment.
@jbrockmendel - this is about ready, just this last todo I think. Was wondering if you could have a look here.
There was a problem hiding this comment.
I don’t have any good ideas here.
There was a problem hiding this comment.
Looks like for Period, Timestamp, Timedelta, there is this in there:
@set_module("pandas")
class Period(PeriodMixin):So maybe that's all you need to do?
There was a problem hiding this comment.
Right. This relates to the doc issue for Interval that is the same as what happened with the offsets. Maybe we should make the cdef class _Interval and then just have the python class Interval with all the docs, etc., and have Interval be a subclass of _Interval
There was a problem hiding this comment.
I don't think that'd be worth it just to set the __module__ attribute, I am okay here as-is.
There was a problem hiding this comment.
Resolved via cython/cython#7231 (comment)
3 participants
__module__on top-level public objects #55178 (Replace xxxx with the GitHub issue number)doc/source/whatsnew/vX.X.X.rstfile if fixing a bug or adding a new feature.This PR addresses all
__module__attributes of public objects that I can find with the exception of functions. It's not clear to me if we want to also be modifying the__module__attribute of e.g.pandas.factorizeand even if we do, I'd like to keep that separate as this PR is already becoming sizable.Remaining documentation that contains
.core.:API docs
User Guide
Getting Started
no output.