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.

Sign up for GitHub

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

Jump to bottom

Add doc pages for general principles #43

Open

ClementPinard opened this issue Oct 4, 2024 · 0 comments

Labels

Collaborator

ClementPinard commented Oct 4, 2024 •

edited

Loading

Have a section dedicated to general principles, with the IO diagram and the class diagram.

Also it will often refer to it, this is different from the API section of docs.

Somewhat similar to the README improvement issue, but ideally more elaborated. #42

Inspiration : https://pandas.pydata.org/docs/user_guide/index.html

ClementPinard added the documentation label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment