Skip to content

Commit 3f423cd

Browse files
authored
DOC: fix RT03,SA01,ES01 for pandas.io.stata.StataReader.variable_labels (#60008)
1 parent a0f9140 commit 3f423cd

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

ci/code_checks.sh

-1
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
154154
-i "pandas.errors.ValueLabelTypeMismatch SA01" \
155155
-i "pandas.infer_freq SA01" \
156156
-i "pandas.io.json.build_table_schema PR07,RT03,SA01" \
157-
-i "pandas.io.stata.StataReader.variable_labels RT03,SA01" \
158157
-i "pandas.io.stata.StataWriter.write_file SA01" \
159158
-i "pandas.json_normalize RT03,SA01" \
160159
-i "pandas.plotting.andrews_curves RT03,SA01" \

pandas/io/stata.py

+10
Original file line numberDiff line numberDiff line change
@@ -2045,9 +2045,19 @@ def variable_labels(self) -> dict[str, str]:
20452045
"""
20462046
Return a dict associating each variable name with corresponding label.
20472047
2048+
This method retrieves variable labels from a Stata file. Variable labels are
2049+
mappings between variable names and their corresponding descriptive labels
2050+
in a Stata dataset.
2051+
20482052
Returns
20492053
-------
20502054
dict
2055+
A python dictionary.
2056+
2057+
See Also
2058+
--------
2059+
read_stata : Read Stata file into DataFrame.
2060+
DataFrame.to_stata : Export DataFrame object to Stata dta format.
20512061
20522062
Examples
20532063
--------

0 commit comments

Comments
 (0)