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

docs/readme improvements #44

Open

3 of 6 tasks

AgnieszkaZaba opened this issue Feb 1, 2025 · 0 comments

Collaborator

AgnieszkaZaba commented Feb 1, 2025 •

edited by slayoo

Loading

mention examples in the README + Colab links!
add example for show_plot
add example with pytest fixture
enrich docstrings based on what got updated in README
short usable code snippets in README functions section (so one can copy and paste into a notebook)
info how to enable rich notebook diff in GitHub

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