expand docs for group layers, delegates and context menu #40
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## wgraham/basic-docs #40 +/- ##
===================================================
Coverage 89.66% 89.66%
===================================================
Files 8 8
Lines 484 484
===================================================
Hits 434 434
Misses 50 50 ☔ View full report in Codecov by Sentry. |
willGraham01
approved these changes
Jul 10, 2024
alessandrofelder
pushed a commit
that referenced
this pull request
Jul 10, 2024
* Basic Sphinx build and docs structure * Workflow to publish docs on pushes to main * Separate sphinx requirements from package requirements * Add building the docs section * Reorganise group_layers docs * Docs API for Groups & Nodes, some source docstring updates for text rendering * Placeholder for widget docs * Write widget docs page * Add note on hashing things * expand docs for group layers, delegates and context menu (#40) --------- Co-authored-by: Kimberly Meechan <[email protected]>
alessandrofelder
added a commit
that referenced
this pull request
Jul 10, 2024
* Pull sample blobs code * Strip away everything except the open-able widget * Some basic structures that track the existing layers * BROKEN: Image layers don't play nice but I did combine the emitter objects * HACK: Napari will now load up, but this hasn't really fixed the naming issue. I've just hacked in a missing attribute to all of the GroupLayer children - they need to have a Node mixin to behave properly * I can see when layers are added, and have some kind of list. Still get SEG-faults or index errors when moving groups within groups, particularly empty group into empty group. * Recognises add/remove layers from viewer and auto-adds to the group layers view. Still seg-fault bug when nesting two empty group layers * Rename classes to be closer to development language * Rename and move items to break things up * Link up group layer selection with layer tab * Reliable testing framework * Fix our failing test suite (#13) * Edit file name to be specific to our use case * Rename single test * Add checks on napari `main` (#18) * Add workflow step to run tests on head of napari * Add optional dependency on napari-latest which fetches napari from the git repo directly * Create an optional install that uses HEAD of napari, add it to list of tests * Add note that napari-latest install is available to README * Update README.md Co-authored-by: Alessandro Felder <[email protected]> --------- Co-authored-by: Alessandro Felder <[email protected]> * Add conftest and some fixtures for testing (#15) * Add conftest.py for shared fixtures and do a quick model check for our QtGroupLayerModel * Typehints don't carry through fixtures * Allow renaming of layers / group layers (#19) * allow renaming of groups and layers * keep prefix for group layers and update setRoot * remove unused tree_model * add initial tests for renaming * add test for editing state on double click * move tests into test_group_layer_widget * Correctly Subclass our `GroupLayer` (#20) * Ensure GroupLayer subclasses from our own subclass of Node * Define ambiguously inherited attributes (IE ensure I don't break KM's tests) * Actually use the nested structure fixture so ruff doesn't get angry * Reorganise the test suite fixture layout since it's starting to get bloated * Basic tests to check is_group and strict typing * Self-review * Allow _check_if_already_tracking to be optionally recursive. Write test for method. * Update src/napari_experimental/group_layer.py Co-authored-by: Kimberly Meechan <[email protected]> * Dammit linter --------- Co-authored-by: Kimberly Meechan <[email protected]> * Adds independent layer controls to widget (#22) * add group layer controls * fix controls for latest changes to group layer * remove syncing of selection * add tests for group layer controls * fix TypeError * expand docstrings * react to sub-groups * add overview and todo sections to readme (#31) * Sync GroupLayer and Main Viewer layer orders (#26) * Allow group_layer to return a flat index * Enforce layer order updates through the GroupLayer events * Rework how items are added to GroupLayers to make things more explicit * Remove unused function * Docstring Tidy (#27) * Some docstrings for _widget * Docstrings for GroupLayerNode class * docstrings for group_layer_qt * Docstrings for group_layer.py * Add attributes and methods to classes where necessary * Missed a rename * Add tests for widget activity * Test for layer deletion sync * Ruff for 3.9 disagrees with 3.11 * strict keyword not in Py3.9 * Update test_and_deploy.yml (#32) (#33) * Fix Errors when Moving Layers (#28) * Allow group_layer to return a flat index * Enforce layer order updates through the GroupLayer events * Rework how items are added to GroupLayers to make things more explicit * Remove unused function * Docstring Tidy (#27) * Some docstrings for _widget * Docstrings for GroupLayerNode class * docstrings for group_layer_qt * Docstrings for group_layer.py * Add attributes and methods to classes where necessary * Missed a rename * Write method that fixes the min failing example * Hey look, a docstring! * Remove double-counting of positions after destination * Test revise index method, remove redundant variable passed * Maybe this is correct if I have a flat index sort a priori * Fix ordering issue and allow for Groups to be assigned a flatindex * Add 2nd test to check moving items out of different subgroups still tracks order correctly * Remove un-necessary variable * Remove commented-out experimental code * Apply suggestions from @K-Meech code review * Add `Implementation` section to README (#34) * MDLint + alessandrofelder -> brainglobe in README * Create implementation deatils section * Group and Node subclassing explanations * Notes on indexing conventions * Update README.md Co-authored-by: Kimberly Meechan <[email protected]> --------- Co-authored-by: Kimberly Meechan <[email protected]> * Add right click menu and styling (#29) * add group layer delegate * rename group layer delegate * add context for right click menu * working minimal right click menu * fix syncing of selection * update docstrings and remove unused functions * fix double click edit * simplify right click actions and context to fix tests * update docstrings * Force widget in tests to have a parent (#35) * Allows toggling visibility of group layers (#30) * toggle visiblity for group layers * add tests for visiblity * update docstrings * fix failing tests * remove logger and thumbnail role * fix view controls when switching from group to layer --------- Co-authored-by: Will Graham <[email protected]> * `main` and `ARC-dev-branch` merge commit reconcile (#37) * Fix bugs relating to empty `GroupLayers` (#38) * Fix seg-faults and broken drag-and-drop via overwriting index method * Switch to unique ID trackers over reimplementing method. Allows safe overwride of __eq__ and __hash__ * Remove one bug from the README broken features section --------- Co-authored-by: Alessandro Felder <[email protected]> * Add docs build and populate content (#39) * Basic Sphinx build and docs structure * Workflow to publish docs on pushes to main * Separate sphinx requirements from package requirements * Add building the docs section * Reorganise group_layers docs * Docs API for Groups & Nodes, some source docstring updates for text rendering * Placeholder for widget docs * Write widget docs page * Add note on hashing things * expand docs for group layers, delegates and context menu (#40) --------- Co-authored-by: Kimberly Meechan <[email protected]> --------- Co-authored-by: Alessandro Felder <[email protected]> Co-authored-by: Kimberly Meechan <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
What is this PR
What does this PR do?
GroupDelegateand context menu classesI looked through the various classes I wrote, and I wasn't sure any would require extra description in a docs page (except the selection propagation). For now I've left just a brief description in the
implementationpage, but happy to add pages for each with a brief description + autodoc if you'd prefer.References
None
How has this PR been tested?
N/A
Is this a breaking change?
No
Does this PR require an update to the documentation?
Documentation updated.
Checklist: