Add ROI editor instructions for operators with ROI properties #136
Conversation
This file contains hidden or 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
glopesdev
force-pushed
the
roi-instructions
branch
2 times, most recently
from
2a93147 to
399e1a2
Compare
|
@banchan86 Thanks for pushing this, it has been a long time coming. I have reviewed by adding a reference from a missing operator I decided to use subsections rather than bullet points to list the possible actions, as that will both include them in the TOC and make them shareable with a URL. Similar to the recommendations in #120 I have used |
glopesdev
force-pushed
the
roi-instructions
branch
from
399e1a2 to
89deb52
Compare
Using section headers over bullet points places commands in the TOC. We have also added missing commands and used `<kbd>` tags to mark keyboard shortcuts.
glopesdev
force-pushed
the
roi-instructions
branch
from
89deb52 to
8e570e6
Compare
|
@glopesdev thanks for the edits, everything looks great to me! |
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.
Fixes #134.
After reviewing the operators, it looks like there are only five operators in the current
Bonsai.Coredocs that use a ROI editor, and there are two main variants, a single ROI editor and one that accepts polygonal/multiple editors. Thus I have created twooverwritemarkdown snippets that can be included with each operator.There may be other
ROI editorsused by operators outside ofBonsai.Core. For exampleScreenCaptureStreamuses anIplImageOutputRectangleEditorbut theBonsai.Videopackage doesn’t have a website setup yet. I will just make a note and address them as I come across them.