Skip to content

Fix NaT and NA docs: Set __module__ to "pandas" to prevent wrong alias message #62313

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Fix NaT and NA docs: Set __module__ to "pandas" to prevent wrong alias message #62313

wants to merge 4 commits into from
+3 −0

Conversation

meet-vasita
Copy link

Set __module__ = "pandas" on NaTType and NAType to fix incorrect autodoc "alias of" messages.
Closes #62185.

meet-vasita and others added 3 commits September 11, 2025 01:06
@meet-vasita
Fix NaT and NA docs: Set __module__ to 'pandas' to prevent wrong alia…
2f53d18 
…s message

Set __module__ = 'pandas' on NaTType and NAType to fix incorrect autodoc 'alias of' messages.
Closes pandas-dev#62185.
@meet-vasita
DOC: Set __module__ attribute for NA and NaT classes
d8f80de 
Fixes Sphinx autodoc showing circular 'alias of' references
for pandas.NA and pandas.NaT by explicitly setting their
__module__ attribute to 'pandas'.

Closes pandas-dev#62185
@meet-vasita
Merge branch 'main' into fix/nat-na-docs
5388ab0
@meet-vasita
Copy link
Author

meet-vasita commented Sep 10, 2025 •
edited
Loading

Hi @rhshadrach, I've implemented your suggested fix by adding __module__ = "pandas" to both NAType and NaTType classes.

Would you be able to review this PR when you have a chance? Thanks for identifying the root cause and providing the solution direction.

@meet-vasita meet-vasita mentioned this pull request Sep 10, 2025
Open
1 task
@simonjayhawkins
Copy link
Member

/docbuild

@simonjayhawkins
Copy link
Member

/preview

@github-actions GitHub Actions
Copy link
Contributor

Website preview of this PR available at: https://pandas.pydata.org/preview/pandas-dev/pandas/62313/

@simonjayhawkins
Copy link
Member

@meet-vasita thanks for the PR.

i'm not seeing any difference at https://pandas.pydata.org/preview/pandas-dev/pandas/62313/docs/reference/api/pandas.NA.html or https://pandas.pydata.org/preview/pandas-dev/pandas/62313/docs/reference/api/pandas.NaT.html

@rhshadrach
Copy link
Member

rhshadrach commented Sep 15, 2025 •
edited
Loading

Thanks @meet-vasita and @simonjayhawkins - I think the remaining issue is that NA and NaT are not classes, they are instances of classes. I don't believe instances play well with autodoc. I get the "desired" output by changing https://github.com/pandas-dev/pandas/blob/main/doc/source/reference/missing_value.rst to use

api.typing.NAType

and

api.typing.NaTType

But there is the less-than desired effect of having the class show up in the API page. Open to thoughts here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
Docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

DOC: NaT - "alias of NaT"; NA - "alias of <NA>"
3 participants
@meet-vasita @simonjayhawkins @rhshadrach