Intents docs #66
Open
Intents docs #66
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 Report
@@ Coverage Diff @@
## master #66 +/- ##
==========================================
- Coverage 28.71% 28.69% -0.02%
==========================================
Files 79 79
Lines 7286 7356 +70
==========================================
+ Hits 2092 2111 +19
- Misses 5194 5245 +51
Continue to review full report at Codecov.
|
ihumphrey
reviewed
Jan 22, 2021
|
|
||
| ### The Lifecycle of an Intent | ||
|
|
||
| A `GUIPlugin` that supports intents will contain a `CanvasManager`. |
There was a problem hiding this comment.
we might need to explain what a canvas manager is? depends on how detailed we want the documentation to be here
There was a problem hiding this comment.
separate document for more advanced components
ihumphrey
reviewed
Jan 22, 2021
| A `GUIPlugin` that supports intents will contain a `CanvasManager`. | ||
| Active intents will be rendered into a `Canvas` owned by the `CanvasManager`. | ||
| When an `Intent` is activated, the manager may generate a new `Canvas` for its rendering. | ||
| In cases such as co-plotting, a pre-existing `Canvas` may be used; that choice is based on the corresponding intents' `match_key` attributes. |
There was a problem hiding this comment.
provide example op of match_key
ihumphrey
reviewed
Jan 22, 2021
| - ErrorBarIntent | ||
| - BarIntent | ||
|
|
||
| Although these types are primitive, additional specialized features can be added to them by specifying `mixin`'s. |
There was a problem hiding this comment.
what is a mixin at a very high level? example of mixin
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.
No description provided.