Skip to content

DOC Update hgbt docstrings on categorical_features default value #28485

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

Closed
wants to merge 1 commit into from

Conversation

ArturoAmorQ
Copy link
Member

Reference Issues/PRs

In #26411 we added the option the support of categorical_features="from_dtype".
As mentioned in #26411 (comment), the docstrings need to be updated accordingly. It's still written default=None.

What does this implement/fix? Explain your changes.

This PR fixes the issue.

Any other comments?

Copy link

✔️ Linting Passed

All linting checks passed. Your pull request is in excellent shape! ☀️

Generated for commit: c5a24e2. Link to the linter CI: here

@jeremiedbb
Copy link
Member

"warn" is just there during the deprecation cycle, but falls back to None. We usually keep the default value to its effective value in the docstring during that time.

@ArturoAmorQ
Copy link
Member Author

I see. Then I guess I misunderstood Olivier's comment! 😅

Closing this one!

@jeremiedbb
Copy link
Member

jeremiedbb commented Feb 20, 2024

Olivier's comment was about "by_dtype" which is the effective value. But we'll do the change in the docstring in 1.6 when the default value actually change to "by_dtype".

@ArturoAmorQ ArturoAmorQ deleted the hgbt_docstrings branch February 27, 2024 16:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants