Skip to content
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

DOCS: fix docstring validation errors for pandas.Series #59600

Merged
merged 2 commits into from
Aug 25, 2024
Merged

DOCS: fix docstring validation errors for pandas.Series #59600

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
8427640
DOCS: fix docstring validation errors for pandas.Series
githubalexliu Aug 25, 2024
6c1c618
DOCS: fix underline length
githubalexliu Aug 25, 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
2 changes: 0 additions & 2 deletions ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,8 +159,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.Series.str.replace SA01" \
-i "pandas.Series.str.wrap RT03,SA01" \
-i "pandas.Series.str.zfill RT03" \
-i "pandas.Series.struct.dtypes SA01" \
-i "pandas.Series.to_markdown SA01" \
-i "pandas.Timedelta.asm8 SA01" \
-i "pandas.Timedelta.ceil SA01" \
-i "pandas.Timedelta.components SA01" \
Expand Down
4 changes: 4 additions & 0 deletions pandas/core/arrays/arrow/accessors.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,6 +244,10 @@ def dtypes(self) -> Series:
pandas.Series
The data type of each child field.

See Also
--------
Series.dtype: Return the dtype object of the underlying data.

Examples
--------
>>> import pyarrow as pa
Expand Down
5 changes: 5 additions & 0 deletions pandas/core/series.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1617,6 +1617,11 @@ def to_markdown(
str
{klass} in Markdown-friendly format.

See Also
--------
Series.to_frame : Rrite a text representation of object to the system clipboard.
Series.to_latex : Render Series to LaTeX-formatted table.

Notes
-----
Requires the `tabulate <https://pypi.org/project/tabulate>`_ package.
Expand Down