Skip to content

DOC: Enforce Numpy Docstring Validation for pandas.Interval.mid #58572

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
May 4, 2024
Merged

DOC: Enforce Numpy Docstring Validation for pandas.Interval.mid #58572

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
e3b957e
DOC: add SA01 for pandas.Interval.mid
tuhinsharma121 May 4, 2024
c1d59df
DOC: remove SA01 for pandas.Interval.mid
tuhinsharma121 May 4, 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 @@ -89,7 +89,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.Interval PR02" \
-i "pandas.Interval.closed SA01" \
-i "pandas.Interval.left SA01" \
-i "pandas.Interval.mid SA01" \
-i "pandas.Interval.right SA01" \
-i "pandas.IntervalIndex.closed SA01" \
-i "pandas.IntervalIndex.contains RT03" \
Expand Down
6 changes: 6 additions & 0 deletions pandas/_libs/interval.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,12 @@ cdef class IntervalMixin:
"""
Return the midpoint of the Interval.

See Also
--------
Interval.left : Return the left bound for the interval.
Interval.right : Return the right bound for the interval.
Interval.length : Return the length of the interval.

Examples
--------
>>> iv = pd.Interval(0, 5)
Expand Down
Loading