Skip to content

docs: Apply miscellaneous fixes to deephaven.ui docs#1162

Merged
arman-ddl merged 5 commits into
mainfrom
afarhangi_dh_ui_fixes
Apr 22, 2025
Merged

docs: Apply miscellaneous fixes to deephaven.ui docs#1162
arman-ddl merged 5 commits into
mainfrom
afarhangi_dh_ui_fixes

Conversation

@arman-ddl
Copy link
Copy Markdown
Contributor

No description provided.

@arman-ddl arman-ddl self-assigned this Apr 15, 2025
@arman-ddl arman-ddl changed the title Apply miscellaneous fixes to deephaven.ui docs docs: Apply miscellaneous fixes to deephaven.ui docs Apr 15, 2025
@github-actions
Copy link
Copy Markdown

ui docs preview (Available for 14 days)

@arman-ddl arman-ddl marked this pull request as ready for review April 15, 2025 23:06
@github-actions
Copy link
Copy Markdown

ui docs preview (Available for 14 days)

mattrunyon
mattrunyon previously approved these changes Apr 15, 2025
Comment thread plugins/ui/docs/installation.md Outdated
Comment thread plugins/ui/docs/README.md Outdated

```python
my_button = ui.button("Click Me!", on_press=lambda e: print(f"Button was clicked! {e}"))
my_button = ui.button("Click Me!", on_press=lambda e: print(f"Button was clicked!"))
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Including the event data was intentional to show that what it contains.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The code is out-of-sync with the image. So then the image is the issue?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You are right, I retract this comment.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This brings up a good point though. This section is called "Handling events". I think we should either fix the SS to match original code or delete the section. Agree?

Btw, feel free to push whatever you want to this branch. Last time I added images, it was strangely small.

Copy link
Copy Markdown
Contributor Author

@arman-ddl arman-ddl Apr 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've reverted the code change and added a SS. Despite my efforts, this SS looks diff than the others, mainly I guess b/c of differences in dh.ui defaults from then and now (button coloring and positioning).

I'm not going to go through dh.ui docs and update the rest of the SS's, so I'll let you decide what you want to do.

Comment thread plugins/ui/docs/tutorial.md Outdated
Co-authored-by: margaretkennedy <82049573+margaretkennedy@users.noreply.github.com>
Co-authored-by: Don <donmckenzie@deephaven.io>
@github-actions
Copy link
Copy Markdown

ui docs preview (Available for 14 days)

dsmmcken
dsmmcken previously approved these changes Apr 16, 2025
@github-actions
Copy link
Copy Markdown

ui docs preview (Available for 14 days)

@arman-ddl arman-ddl requested a review from dsmmcken April 17, 2025 21:46
@arman-ddl arman-ddl merged commit 01693d7 into main Apr 22, 2025
17 checks passed
@arman-ddl arman-ddl deleted the afarhangi_dh_ui_fixes branch April 22, 2025 16:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants