-
Notifications
You must be signed in to change notification settings - Fork 16
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: Updating examples for consistency #378
Conversation
- Adding some more basic examples, adding only one concept with each example - Start with a couple one-liners - Clean up state, need to start cleaning up after "Using State"
- Update all import deephaven.ui to from deephaven import ui - Have some more basic examples to start - Clean up a lot of examples - Fixes deephaven#341 - Next I think we _need_ a Components section that just details each component. Like copy over what we have with DESIGN.md, add an example. Would only be the things that have been implemented, while DESIGN.md has the full spec. - There are a few links to React Spectrum components, when instead we should just link our own Components section
Let's start a docs folder that will eventually become the official docs.
|
count, set_count = ui.use_state(0) | ||
|
||
def handle_press(): | ||
set_count(count + 1) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe the classic increment/decrement example would fit better here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changed it up a bit, let me know what you think.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Most notably, all examples will only appear within one panel in the UI, the
ui.table
functionality (allowing interactivity and customization of displayed tables), and ability to use other plugins (such as deephaven.plot.express) is not yet implemented.
That could be updated too.
Co-authored-by: margaretkennedy <[email protected]>
import deephaven.ui as ui
tofrom deephaven import ui