Skip to content

Commit f60675d

Browse files
FactorizeDMateusz
and
Mateusz
authored
DOC: Improve .at indexer API docs (#46734)
GH46722 Co-authored-by: Mateusz <[email protected]>
1 parent 56985bb commit f60675d

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
@@ -540,14 +540,30 @@ def at(self) -> _AtIndexer:
540540
Raises
541541
------
542542
KeyError
543-
If 'label' does not exist in DataFrame.
543+
* If getting a value and 'label' does not exist in a DataFrame or
544+
Series.
545+
ValueError
546+
* If row/column label pair is not a tuple or if any label from
547+
the pair is not a scalar for DataFrame.
548+
* If label is list-like (*excluding* NamedTuple) for Series.
544549
545550
See Also
546551
--------
552+
DataFrame.at : Access a single value for a row/column pair by label.
547553
DataFrame.iat : Access a single value for a row/column pair by integer
548554
position.
549555
DataFrame.loc : Access a group of rows and columns by label(s).
550-
Series.at : Access a single value using a label.
556+
DataFrame.iloc : Access a group of rows and columns by integer
557+
position(s).
558+
Series.at : Access a single value by label.
559+
Series.iat : Access a single value by integer position.
560+
Series.loc : Access a group of rows by label(s).
561+
Series.iloc : Access a group of rows by integer position(s).
562+
563+
Notes
564+
-----
565+
See :ref:`Fast scalar value getting and setting <indexing.basics.get_value>`
566+
for more details.
551567
552568
Examples
553569
--------

0 commit comments

Comments
 (0)