Skip to content

DOC Improve consistency of inverse_transform return name #31135

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

Merged

Conversation

jeremiedbb
Copy link
Member

Use the same name for the returned arrays of all inverse_transform methods.

Note that it doesn't change the API, just a name in the docstring. The goal is more consistency in the doc.

Alternative names: X_inv, X_reconstructed, X, Xt, Xr. I went for X_original because it was already used in a bunch of estimators and was my preference. Let me know if you prefer another name (even one not listed here).

Copy link

github-actions bot commented Apr 2, 2025

✔️ Linting Passed

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

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

Copy link
Member

@lucyleeow lucyleeow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! I like *_original

@lucyleeow lucyleeow added the Waiting for Second Reviewer First reviewer is done, need a second one! label Apr 28, 2025
@adrinjalali adrinjalali merged commit 7db1015 into scikit-learn:main Apr 30, 2025
47 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Waiting for Second Reviewer First reviewer is done, need a second one!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants