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

docs: Add a set of examples in cookbook #123

Merged
merged 10 commits into from
Jan 28, 2025

Conversation

jacopoabramo
Copy link
Contributor

@jacopoabramo jacopoabramo commented Jan 28, 2025

A PR to provide a cookbook section in the documentation which can be used as a reference to use ndv in different contexts.

I added 3 examples on how to embed ArrayViewer.widget() in a custom Qt application (was also a learning experience for me!)

  • ndv with a couple of pushbuttons to select one dataset or the other;
  • multiple ndv.ArrayViewer widgets in the same QWidget;
  • a pseudo-microscope dashboard using openwfs.

In the first example I also wanted to add a button to show the cells3d dataset but after loading it, the 2D datasets were squashed and I did not know how to fix the behavior; for a minimal example though I believe it should work even without cells3d

Copy link

codecov bot commented Jan 28, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 75.85%. Comparing base (7da803e) to head (ef6ee85).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #123   +/-   ##
=======================================
  Coverage   75.85%   75.85%           
=======================================
  Files          49       49           
  Lines        4950     4950           
=======================================
  Hits         3755     3755           
  Misses       1195     1195           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@tlambert03 tlambert03 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

super cool! ❤️ thank you!

I have a few suggestions/requests. I'll mark them inline

@jacopoabramo
Copy link
Contributor Author

Hopefully that should do it

Copy link
Member

@tlambert03 tlambert03 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

perfect. thanks I'm very happy with this. Will follow up shortly to get those awesome screenshots back

@tlambert03 tlambert03 changed the title Add a set of examples in cookbook docs: Add a set of examples in cookbook Jan 28, 2025
@tlambert03 tlambert03 added the documentation Improvements or additions to documentation label Jan 28, 2025
@tlambert03 tlambert03 merged commit 9242f02 into pyapp-kit:main Jan 28, 2025
52 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants