Skip to content

Commit dc2e0ee

Browse files
author
Mateusz
committed
DOC: Improve .at indexer API docs
GH46722
1 parent 04e01a1 commit dc2e0ee

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

pandas/core/indexing.py

+18-2
Original file line numberDiff line numberDiff line change
@@ -539,14 +539,30 @@ def at(self) -> _AtIndexer:
539539
Raises
540540
------
541541
KeyError
542-
If 'label' does not exist in DataFrame.
542+
* If getting a value and 'label' does not exist in a DataFrame or
543+
Series.
544+
ValueError
545+
* If row/column label pair is not a tuple or if any label from
546+
the pair is not a scalar for DataFrame.
547+
* If label is list-like (*excluding* NamedTuple) for Series.
543548
544549
See Also
545550
--------
551+
DataFrame.at : Access a single value for a row/column pair by label.
546552
DataFrame.iat : Access a single value for a row/column pair by integer
547553
position.
548554
DataFrame.loc : Access a group of rows and columns by label(s).
549-
Series.at : Access a single value using a label.
555+
DataFrame.iloc : Access a group of rows and columns by integer
556+
position(s).
557+
Series.at : Access a single value by label.
558+
Series.iat : Access a single value by integer position.
559+
Series.loc : Access a group of rows by label(s).
560+
Series.iloc : Access a group of rows by integer position(s).
561+
562+
Notes
563+
-----
564+
See :ref:`Fast scalar value getting and setting <indexing.basics.get_value>`
565+
for more details.
550566
551567
Examples
552568
--------

0 commit comments

Comments
 (0)