Skip to content

DOC: Enforce Numpy Docstring Validation for pandas.Interval.closed #58569

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

Closed
wants to merge 3 commits into from
Closed

DOC: Enforce Numpy Docstring Validation for pandas.Interval.closed #58569

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
36109f5
DOC: add SA01 for pandas.Interval.closed
tuhinsharma121 May 4, 2024
bacfca6
DOC: remove SA01 for pandas.Interval.closed
tuhinsharma121 May 4, 2024
f97c177
DOC: add SA01 for pandas.Interval.closed
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 @@ -87,7 +87,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.Index.ravel PR01,RT03" \
-i "pandas.Index.str PR01,SA01" \
-i "pandas.Interval PR02" \
-i "pandas.Interval.closed SA01" \
-i "pandas.Interval.left SA01" \
-i "pandas.Interval.mid SA01" \
-i "pandas.Interval.right SA01" \
Expand Down
7 changes: 7 additions & 0 deletions pandas/_libs/interval.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -405,6 +405,13 @@ cdef class Interval(IntervalMixin):

Either ``left``, ``right``, ``both`` or ``neither``.

See Also
--------
Interval.closed_left : Check if the interval is closed on the left side.
Interval.closed_right : Check if the interval is closed on the right side.
Interval.open_left : Check if the interval is open on the left side.
Interval.open_right : Check if the interval is open on the right side.

Examples
--------
>>> interval = pd.Interval(left=1, right=2, closed='left')
Expand Down