docs: use_render_queue, use_liveness_scope, use_table_listener docs #1044
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
Member
mofojed
commented
Nov 26, 2024
mofojed
commented
- Adding some more missing hooks documentation
- Closes docs: use_liveness_scope #823, closes deephaven.ui hooks documentation #659
- Adding some more missing hooks documentation - Closes deephaven#823, closes deephaven#659
mofojed
commented
Nov 26, 2024
- Remove the API reference to use_render_queue. The autodoc doesn't work correctly if the function has no parameters - Remove redundant information from the README at the base - Update signature for use_table_listener
margaretkennedy
previously approved these changes
Nov 27, 2024
jnumainville
requested changes
Dec 5, 2024
| @@ -0,0 +1,31 @@ | |||
| # use_row_data | |||
|
|
|||
| `use_row_data` lets you use the data of the first row of a table. This is useful when you want to listen to an updating table and use the data in your component. | |||
There was a problem hiding this comment.
It's not entirely clear what the format of a row of data is here by just looking at the document. Perhaps a contrast with use_row_list as someone would likely be trying to figure out which they want of those two.
There was a problem hiding this comment.
I'll specify one returns a dictionary and the other returns a list in the intro paragraph.
Co-authored-by: margaretkennedy <[email protected]>
| my_toast_table = toast_table(_source) | ||
| ``` | ||
|
|
||
| The above example listens to table updates and displays a toast message when the table updates. The `toast` function must be triggered on the render thread, whereas the listener is not fired on the render thread. Therefore, you must use the render queue to trigger the toast. |
There was a problem hiding this comment.
It would useful to define toast or link to its docs - comes out of nowhere.
| @@ -0,0 +1,84 @@ | |||
| # use_table_listener | |||
|
|
|||
| `use_table_listener` lets you listen to a table for updates. This is useful when you want to listen to a table and perform an action when the table updates. | |||
There was a problem hiding this comment.
The "this is an advanced feature" caveat should be mentioned in the paragraph, IMO. Stop someone in their tracks before getting to UI recommendations.
Co-authored-by: margaretkennedy <[email protected]>
- Specify list or dict for the row_data vs row_list methods - Add link to toast - Add warning in the use_table_listener hook intro paragraph
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.