Skip to content

DOC: fix reference to api.typing.NaTType (from api.types.NaTType) #57309

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

Merged
merged 1 commit into from
Feb 9, 2024

Conversation

choucavalier
Copy link
Contributor

@choucavalier choucavalier commented Feb 9, 2024

Effectively, the NaTType definition lives under api.typing and not api.types

…Type)

Effectively, the `NaTType` definition leaves under `api.typing` and not `api.types`
@@ -21,7 +21,7 @@ is that the original data type will be coerced to ``np.float64`` or ``object``.
pd.Series([True, False], dtype=np.bool_).reindex([0, 1, 2])

:class:`NaT` for NumPy ``np.datetime64``, ``np.timedelta64``, and :class:`PeriodDtype`. For typing applications,
use :class:`api.types.NaTType`.
use :class:`api.typing.NaTType`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IIUC we now recommend using the stubs for typing applications.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Stubs are just to type our API and not to give users objects to type stuff themselves afaik

@phofl phofl merged commit 16e36dc into pandas-dev:main Feb 9, 2024
@phofl
Copy link
Member

phofl commented Feb 9, 2024

thx @tgy

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants