Skip to content

Commit b63c795

Browse files
DOC: fix SA01, ES01 for pandas.io.stata.StataReader.data_label (#59962)
1 parent 24190fd commit b63c795

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

ci/code_checks.sh

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
179179
-i "pandas.errors.ValueLabelTypeMismatch SA01" \
180180
-i "pandas.infer_freq SA01" \
181181
-i "pandas.io.json.build_table_schema PR07,RT03,SA01" \
182-
-i "pandas.io.stata.StataReader.data_label SA01" \
183182
-i "pandas.io.stata.StataReader.value_labels RT03,SA01" \
184183
-i "pandas.io.stata.StataReader.variable_labels RT03,SA01" \
185184
-i "pandas.io.stata.StataWriter.write_file SA01" \

pandas/io/stata.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2004,6 +2004,16 @@ def data_label(self) -> str:
20042004
"""
20052005
Return data label of Stata file.
20062006
2007+
The data label is a descriptive string associated with the dataset
2008+
stored in the Stata file. This property provides access to that
2009+
label, if one is present.
2010+
2011+
See Also
2012+
--------
2013+
io.stata.StataReader.variable_labels : Return a dict associating each variable
2014+
name with corresponding label.
2015+
DataFrame.to_stata : Export DataFrame object to Stata dta format.
2016+
20072017
Examples
20082018
--------
20092019
>>> df = pd.DataFrame([(1,)], columns=["variable"])

0 commit comments

Comments
 (0)