Skip to content

DOC: Enforce Numpy Docstring Validation for pandas.IntervalIndex.closed and pandas.arrays.IntervalArray.closed #58608

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

DOC: Enforce Numpy Docstring Validation for pandas.IntervalIndex.closed and pandas.arrays.IntervalArray.closed #58608

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
368ec94
DOC: add SA01 for pandas.IntervalIndex.closed and pandas.arrays.Inter…
tuhinsharma121 May 7, 2024
73f2f27
DOC: remove SA01 for pandas.IntervalIndex.closed and pandas.arrays.In…
tuhinsharma121 May 7, 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 @@ -78,7 +78,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.Grouper PR02" \
-i "pandas.Index PR07" \
-i "pandas.Interval PR02" \
-i "pandas.IntervalIndex.closed SA01" \
-i "pandas.IntervalIndex.contains RT03" \
-i "pandas.IntervalIndex.get_loc PR07,RT03,SA01" \
-i "pandas.IntervalIndex.is_non_overlapping_monotonic SA01" \
Expand Down Expand Up @@ -418,7 +417,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.arrays.DatetimeArray SA01" \
-i "pandas.arrays.FloatingArray SA01" \
-i "pandas.arrays.IntegerArray SA01" \
-i "pandas.arrays.IntervalArray.closed SA01" \
-i "pandas.arrays.IntervalArray.contains RT03" \
-i "pandas.arrays.IntervalArray.is_non_overlapping_monotonic SA01" \
-i "pandas.arrays.IntervalArray.left SA01" \
Expand Down
6 changes: 6 additions & 0 deletions pandas/core/arrays/interval.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1389,6 +1389,12 @@ def closed(self) -> IntervalClosedType:

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

See Also
--------
IntervalArray.closed : Returns inclusive side of the IntervalArray.
Interval.closed : Returns inclusive side of the Interval.
IntervalIndex.closed : Returns inclusive side of the IntervalIndex.

Examples
--------

Expand Down