Skip to content

Commit 68dbf6e

Browse files
authored
DOC: Modified docstring of DataFrame.to_dict() to make the usage of orient='records' more clear (#56743)
* 'Modified docstring of Dataframe.to_dict() to make the usage orient='records' moreclear * Changed by pre-commit
1 parent b2bca5e commit 68dbf6e

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

pandas/core/frame.py

+3-1
Original file line numberDiff line numberDiff line change
@@ -2066,7 +2066,9 @@ def to_dict(
20662066
index : bool, default True
20672067
Whether to include the index item (and index_names item if `orient`
20682068
is 'tight') in the returned dictionary. Can only be ``False``
2069-
when `orient` is 'split' or 'tight'.
2069+
when `orient` is 'split' or 'tight'. Note that when `orient` is
2070+
'records', this parameter does not take effect (index item always
2071+
not included).
20702072
20712073
.. versionadded:: 2.0.0
20722074

0 commit comments

Comments
 (0)