-
-
Notifications
You must be signed in to change notification settings - Fork 26k
DOC Add interval notation for include_boundaries in documentation check_scalar #21955
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
Conversation
Thanks @yadav-sachin.
|
Here's the preview: It's ok. Though I think the addition of
|
sklearn/utils/validation.py
Outdated
@@ -1386,10 +1386,13 @@ def check_scalar( | |||
the boundaries. Possible choices are: | |||
|
|||
- `"left"`: only `min_val` is included in the valid interval; | |||
[ min_val, max_val ) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- `"left"`: only `min_val` is included in the valid interval.
It is equivalent to the interval `[ min_val, max_val )`;
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you make similar changes for the other entries?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. @reshamas do you want to have a look before that I merge it?
@glemaitre Can we remove the semicolons at the end of each bullet point? It's a little distracting, and I wouldn't want users to think semicolons are related to intervals. |
I always thought that it was the formal way to write a proper bullet list: https://english.stackexchange.com/a/15134 |
@glemaitre Ok, let's go with full stop at end. |
Thanks @yadav-sachin @reshamas all good to go |
Reference Issues/PRs
Fixes #21947
What does this implement/fix? Explain your changes.
I replaced the sentence descriptions for possible choices of parameter include_boundaries in the documentation of function check_scalar with interval notations.
Any other comments?
The members are discussing which interval notation to use. I went ahead and made changes as per the English notation. Will make changes, if members decide to go ahead with other notation.