Skip to content

Commit 1a34130

Browse files
committed
DOC: update the DataFrame.iat[] docstring
1 parent 9fb7ac9 commit 1a34130

File tree

1 file changed

+27
-3
lines changed

1 file changed

+27
-3
lines changed

pandas/core/indexing.py

+27-3
Original file line numberDiff line numberDiff line change
@@ -1920,11 +1920,35 @@ def _convert_key(self, key, is_setter=False):
19201920

19211921

19221922
class _iAtIndexer(_ScalarAccessIndexer):
1923-
"""Fast integer location scalar accessor.
1923+
"""
1924+
Selects a single value for a row/column pair by integer position.
19241925
1925-
Similarly to ``iloc``, ``iat`` provides **integer** based lookups.
1926-
You can also set using these indexers.
1926+
Useful if performance is a major concern and you only need to
1927+
get or set a value at a particular row/column.
19271928
1929+
See Also
1930+
--------
1931+
at : Selects a single value for a row/column label pair
1932+
loc : Selects a group of rows and columns by label(s)
1933+
iloc : Selects group of rows and columns by integer position(s)
1934+
1935+
Returns
1936+
-------
1937+
None
1938+
1939+
Examples
1940+
--------
1941+
>>> df = pd.DataFrame([[0,2,3], [0,4,1], [10,20,30]])
1942+
>>> df
1943+
0 1 2
1944+
0 0 2 3
1945+
1 0 4 1
1946+
2 10 20 30
1947+
>>> df.iat[1, 2]
1948+
1
1949+
>>> df.iat[1, 2] = 10
1950+
>>> df.iat[1, 2]
1951+
10
19281952
"""
19291953

19301954
_takeable = True

0 commit comments

Comments
 (0)