skrub icon indicating copy to clipboard operation
skrub copied to clipboard

New README proposal

Open LilianBoulard opened this issue 3 years ago • 3 comments

As discussed in #272, this PR proposes a new README for the project.

LilianBoulard avatar Sep 06 '22 15:09 LilianBoulard

I worry that this duplicates too much information from the website. Duplicated information will be hard to maintain and will fall out of sync

GaelVaroquaux avatar Sep 08 '22 08:09 GaelVaroquaux

Apart from the "When is it useful?" part which is too detailed, I find you it's great as it's much clearer. Maybe you can remove/shorten and merge the "When is it useful?" and "What dirty_cat does not"? In any case, you put the link to the website every time, and for every encoder, people will tend to click on it for more information.

jovan-stojanovic avatar Sep 08 '22 08:09 jovan-stojanovic

Okay, since these changes are a point of contention, we should delay the PR, so we can release on Monday, and we can discuss it together on Wednesday, during the sprint :)

LilianBoulard avatar Sep 09 '22 12:09 LilianBoulard

I've moved some parts on the website, which I agree is more suitable. Please check it out and let me know what you think!

LilianBoulard avatar Oct 18 '22 15:10 LilianBoulard

I like what you added to the website! For the part What can dirty_cat do, I fear it will have to change often. We have added recently fuzzy_join and we will add soon deduplication, so it will evolve fast. The rest are all good improvements to me.

jovan-stojanovic avatar Oct 20 '22 14:10 jovan-stojanovic

Great! Maybe it would be cool to add one line on the SuperVectorizer in "What can dirty-cat do?" ? It doesnt' really fit in the rest of the description and it's a really cool feature.

LeoGrin avatar Nov 07 '22 15:11 LeoGrin

I get what you mean, but I feel like this is true for both the SuperVectorizer and the fuzzy join. Without completely reverting what I did earlier, I added some very brief mentions of the most important tools and encoders, in order to guide users.

LilianBoulard avatar Nov 14 '22 13:11 LilianBoulard

LGTM

LeoGrin avatar Nov 14 '22 13:11 LeoGrin

Alright, thanks all for the reviews, merging!

LilianBoulard avatar Nov 14 '22 13:11 LilianBoulard