Skip to content

DOC: define py:type targets for typing aliases #63861

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

Open
RituDSML wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −0
Open

DOC: define py:type targets for typing aliases #63861

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions doc/source/reference/aliases.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,18 @@ Typing aliases
**************

.. currentmodule:: pandas.api.typing.aliases
.. py:type:: AggFuncType
Type of functions that can be passed to :meth:`agg` methods

.. py:type:: AlignJoin
Argument type for ``join`` in :meth:`DataFrame.join`

.. py:type:: AnyAll
Argument type for ``how`` in :meth:`dropna`

.. py:type:: AnyArrayLike
Used to represent :class:`ExtensionArray`, ``numpy`` arrays, :class:`Index` and :class:`Series


The typing declarations in ``pandas/_typing.py`` are considered private, and used
by pandas developers for type checking of the pandas code base. For users, it is
Expand Down
Loading