Skip to content

Improved the documentation of Cleaner#1811

Merged
rcap107 merged 7 commits into
skrub-data:mainfrom
wenebob:doc
Dec 16, 2025
Merged

Improved the documentation of Cleaner#1811
rcap107 merged 7 commits into
skrub-data:mainfrom
wenebob:doc

Conversation

@wenebob

@wenebob wenebob commented Dec 15, 2025

Copy link
Copy Markdown
Contributor

As requested in issue #1785
I included the DropUninformative in the see also section of the Cleaner documentation.
I also built the documentation, and there were no errors.

@rcap107

rcap107 commented Dec 15, 2025

Copy link
Copy Markdown
Member

Hi @Faith-Nchifor, thank for opening the PR. At the moment, the CI is failing because the formatting is incorrect.

In order to fix that problem, you will have to run pre-commit checks in the environment that you are using to develop skrub.
Something like

pre-commit run --all-files

and then commit the modified files.

@rcap107 rcap107 linked an issue Dec 15, 2025 that may be closed by this pull request
@rcap107

rcap107 commented Dec 15, 2025

Copy link
Copy Markdown
Member

I think it would be useful to add the DropUninformative to the "see also" section of the TableVectorizer, since DropUninformative is used by the TableVectorizer in the same way as the Cleaner.

@wenebob

wenebob commented Dec 15, 2025

Copy link
Copy Markdown
Contributor Author

Alright.
I'm working on it

@wenebob

wenebob commented Dec 15, 2025

Copy link
Copy Markdown
Contributor Author

Hey @rcap107
Thank you for the corrections.
I ran the pre-commit checks and included the DropUninformative in TableVectorizer as you suggested.

@rcap107

rcap107 commented Dec 16, 2025

Copy link
Copy Markdown
Member

Hi @Faith-Nchifor, I made a small additional change to the PR adding a cross-reference in the list of steps done by the cleaner.

I'll merge the PR once the tests pass. Thanks a lot!

@rcap107 rcap107 merged commit 63f5379 into skrub-data:main Dec 16, 2025
29 checks passed
@wenebob wenebob deleted the doc branch December 17, 2025 18:39
glemaitre pushed a commit to glemaitre/skrub that referenced this pull request Jan 5, 2026
Co-authored-by: Riccardo Cappuzzo <riccardo.cappuzzo@gmail.com>
glemaitre pushed a commit that referenced this pull request Jan 6, 2026
Co-authored-by: Riccardo Cappuzzo <riccardo.cappuzzo@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

DOC - Improve the documentation of the Cleaner

2 participants