Skip to content
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

Make the documentation more lightweight and readable #951

Open
rluthi opened this issue Dec 18, 2022 · 3 comments
Open

Make the documentation more lightweight and readable #951

rluthi opened this issue Dec 18, 2022 · 3 comments
Assignees
Labels
type: enhancement New feature or request

Comments

@rluthi
Copy link

rluthi commented Dec 18, 2022

DataPrep is a great tool! And the automatic EDA module is probably the best open-source option out there.

However, I find your package difficult to understand and learn from your documentation. It makes it feels more complicated than it actually is.

Some ideas to improve :

  • Highlight 2 line EDA report creation (only advanced users need the detail)
  • Separate documentation from case studies
  • Organise the sub-sections in doc of the Clean module
@rluthi rluthi added the type: enhancement New feature or request label Dec 18, 2022
@rluthi rluthi changed the title Make the documentation more lightweight and readable. Make the documentation more lightweight and readable Dec 18, 2022
@rluthi
Copy link
Author

rluthi commented Dec 18, 2022

If you are interested, I could have a go at this

@anthng
Copy link

anthng commented Dec 27, 2022

If you are interested, I could have a go at this

I agree with you, the documentation is too difficult to learn. Param in each function does not represent clearly in your docs. I hope Datapre improves to better than, anyway this is the best Auto EDA I've used

@dovahcrow
Copy link
Member

Yep I agree. We do have an ongoing branch which switches sphinx to jupyterbook and tidies things up a little bit. I'll share the branch here once it can build successfully. Thanks for your interest in helping out! @rluthi

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants