8000 In check_scalar function, max_val default value should be None · Issue #22031 · scikit-learn/scikit-learn · GitHub
[go: up one dir, main page]
Skip to content

In check_scalar function, max_val default value should be None #22031

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

Jump to bottom
Closed
reshamas opened this issue Dec 20, 2021 · 0 comments · Fixed by #22032
Closed

In check_scalar function, max_val default value should be None #22031

reshamas opened this issue Dec 20, 2021 · 0 comments · Fixed by #22032
Labels
Documentation Easy Well-defined and straightforward way to resolve good first issue Easy with clear instructions to resolve

Comments

@reshamas
Copy link
Member

Describe the issue linked to the documentation

In this documentation for check_scalar,
https://scikit-learn.org/dev/modules/generated/sklearn.utils.check_scalar.html

the max_val has default=False.

Suggest a potential alternative/fix

Change max_val default value to default=None

Note for Beginners

Here are notes on how to get started:

  1. Read the documentation: https://scikit-learn.org/stable/developers/contributing.html
  2. Read notes on Git: https://www.dataschool.io/how-to-contribute-on-github/
  3. Watch videos: https://www.youtube.com/playlist?list=PLBKcU7Ik-ir-b1fwjNabO3b8ebs9ez5ga
  4. Go through the code base, explore it and find the file(s) where the edits need to be made.
  5. Read Stack Overflow's "How do I ask a good question?"
  6. Be inclusive in your communications: inclusive language
    • Do not use salutations such as "Hello Sir", or "Hey guys" (Why: these terms exclude women and non-binary people.)
    • Do not use salutations such as "Hello Sir/Madam" (Why: these terms assume gender is binary, and they exclude non-binary people.)
  7. In general, no need to address people here as "Sir" or "Maam" or "Madam".

Note that due to limited resources, it may take many days before we can review your pull request. Please be patient, and if you don't receive any feedback within two weeks, you can give us a reminder on gitter.
@reshamas reshamas added Documentation Needs Triage Issue requires triage Easy Well-defined and straightforward way to resolve good first issue Easy with clear instructions to resolve and removed Needs Triage Issue requires triage labels Dec 20, 2021
@ghost ghost mentioned this issue Dec 20, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation Easy Well-defined and straightforward way to resolve good first issue Easy with clear instructions to resolve
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

DOC Correct wrong default value in check_scalar docstring
1 participant
@reshamas
0