Update slicing/rendering docs #424
Conversation
github-actions
bot
added
the
documentation
| @@ -1,6 +1,6 @@ | |||
| (nap-4-async-slicing)= | |||
|
|
|||
| # NAP-4: Asynchronous slicing | |||
| # NAP-4 — Asynchronous slicing | |||
There was a problem hiding this comment.
This NAP currently is the only one with a colon, but is now joining the em-dash family :p
|
@andy-sweet This is looking outstanding! |
|
|
||
| ```{code-cell} python | ||
| # To get the current dimension order as tuple of int | ||
| viewer.dims.order | ||
| ``` | ||
| And then, changed programatically as follows: | ||
| And then, changed programmatically as follows: |
There was a problem hiding this comment.
All of the changes in this file are unrelated typo/spelling fixes. I can move them to a different PR.
|
Some more progress here. I think one more push and this should be ready for review. |
|
I'm marking this ready for review mostly because I've run out of steam... I included links to docs, parts of the API, and even private implementation details (where I used permalinks to @brisvag : I included a sub-section on thick slicing here, since it seemed like a good fit for the content. It's not super detailed, but gives a basic example of how to use it and what it means. Feel free to make suggestions there! I think some parts of this are pretty good, but it gets pretty rough in some places. The |
|
Also happy to discuss this in the next documentation working group. |
andy-sweet
changed the title
There was a problem hiding this comment.
@andy-sweet this is awesome, thanks for making all these updates 🙏 I've left some comments, but it's mostly nitpicks!
Co-authored-by: Draga Doncila Pop <[email protected]>
Co-authored-by: Draga Doncila Pop <[email protected]>
|
@DragaDoncila : thanks for the review and the grammar fixes! I think I address all your comments here, but let me know if there are still issues. |
There was a problem hiding this comment.
@andy-sweet thanks for making those updates, this can go in afaic!
|
In that case, I'll merge this after 24 hours unless anyone objects or has other suggestions. |
References and relevant issues
Closes #237
Closes #400
Description
This updates the current rendering docs in napari to reflect a few things.
main.This is still very much a work-in-progress, so isn't worth a review yet. But wanted to share out progress as I make it (slowly...).
Some of the old explanations include some nice context and background material. At the time of writing, I've deleted some of these, but I am looking for ways to integrate them back into these docs.