Skip to content

DOC: add SA01 for pandas.Series.to_string #58779

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.

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 1 commit into from
May 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.Series.to_dict SA01" \
-i "pandas.Series.to_frame SA01" \
-i "pandas.Series.to_markdown SA01" \
-i "pandas.Series.to_string SA01" \
-i "pandas.Series.update PR07,SA01" \
-i "pandas.Timedelta PR07,SA01" \
-i "pandas.Timedelta.as_unit SA01" \
Expand Down
7 changes: 7 additions & 0 deletions pandas/core/series.py
Original file line number Diff line number Diff line change
Expand Up @@ -1491,6 +1491,13 @@ def to_string(
str or None
String representation of Series if ``buf=None``, otherwise None.

See Also
--------
Series.to_dict : Convert Series to dict object.
Series.to_frame : Convert Series to DataFrame object.
Series.to_markdown : Print Series in Markdown-friendly format.
Series.to_timestamp : Cast to DatetimeIndex of Timestamps.

Examples
--------
>>> ser = pd.Series([1, 2, 3]).to_string()
Expand Down
Loading