Skip to content

DOC: fix SA01, ES01 for pandas.io.stata.StataReader.data_label #59962

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 5, 2024
Merged

DOC: fix SA01, ES01 for pandas.io.stata.StataReader.data_label #59962

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d610f69
DOC: fix SA01, ES01 for pandas.io.stata.StataReader.data_label
tuhinsharma121 Oct 4, 2024
8f759b0
Merge branch 'main' into pandas.io.stata.StataReader.data_label
tuhinsharma121 Oct 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.errors.ValueLabelTypeMismatch SA01" \
-i "pandas.infer_freq SA01" \
-i "pandas.io.json.build_table_schema PR07,RT03,SA01" \
-i "pandas.io.stata.StataReader.data_label SA01" \
-i "pandas.io.stata.StataReader.value_labels RT03,SA01" \
-i "pandas.io.stata.StataReader.variable_labels RT03,SA01" \
-i "pandas.io.stata.StataWriter.write_file SA01" \
Expand Down
10 changes: 10 additions & 0 deletions pandas/io/stata.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2004,6 +2004,16 @@ def data_label(self) -> str:
"""
Return data label of Stata file.

The data label is a descriptive string associated with the dataset
stored in the Stata file. This property provides access to that
label, if one is present.

See Also
--------
io.stata.StataReader.variable_labels : Return a dict associating each variable
name with corresponding label.
DataFrame.to_stata : Export DataFrame object to Stata dta format.

Examples
--------
>>> df = pd.DataFrame([(1,)], columns=["variable"])
Expand Down