eng: Added docs for canvas code #26
Open
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
| @@ -16,6 +16,17 @@ | |||
|
|
|||
| from local_app.benchling_app.views.constants import SEARCH_BUTTON_ID, SEARCH_TEXT_ID | |||
|
|
|||
| """ | |||
| This file contains examples of how create a canvas at initialization | |||
There was a problem hiding this comment.
Suggested change
| This file contains examples of how create a canvas at initialization | |
| This file contains examples of how to create a canvas at initialization |
| For examples of updates, check out canvas_interaction.py | ||
|
|
||
| Use a CanvasBuilder to create or update a canvas associated with your app | ||
| This sdk tool can be used for easy creation and updates |
There was a problem hiding this comment.
nit: instead of "sdk tool" i think "this helper" sounds a little better, neither is wrong though
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.
Added some comments to help understand the canvas creation code since Don was really struggling to understand this code.