Skip to content

Add interactive docstring tooltips to ShellV2#1917

Merged
KCarretto merged 5 commits intomainfrom
shell-v2-doc-tooltips-2539696344315748681
Feb 26, 2026
Merged

Add interactive docstring tooltips to ShellV2#1917
KCarretto merged 5 commits intomainfrom
shell-v2-doc-tooltips-2539696344315748681

Conversation

@KCarretto
Copy link
Copy Markdown
Collaborator

Implemented interactive floating docstring tooltips for the ShellV2 terminal and autocomplete menu. The tooltips display function signatures and descriptions parsed from the Eldritch user guide. Hovering over a function name in the terminal or an item in the autocomplete list triggers the tooltip. Used Chakra UI for styling and ensuring visibility with fixed positioning.


PR created automatically by Jules for task 2539696344315748681 started by @KCarretto

- Created `generate-docs.js` script to parse Eldritch documentation from markdown.
- Integrated doc generation into `npm start` and `npm build`.
- Implemented `DocTooltip` component for displaying function signatures and descriptions.
- Updated `useShellTerminal` to detect words under cursor and fetch documentation.
- Updated `ShellTerminal` to render tooltips on hover.
- Updated `ShellCompletions` to display info icon and tooltips for completion items.

Co-authored-by: KCarretto <16250309+KCarretto@users.noreply.github.com>
@google-labs-jules
Copy link
Copy Markdown
Contributor

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Feb 26, 2026

Summary

Tests 📝 Passed ✅ Failed ❌ Skipped ⏭️ Other ❓ Flaky 🍂 Duration ⏱️
2682    ±0 2682    ±0 0    ±0 0    ±0 0    ±0 0    ±0 1ms    ±0

Previous Results

Build 🏗️ Result 🧪 Tests 📝 Passed ✅ Failed ❌ Skipped ⏭️ Other ❓ Flaky 🍂 Duration ⏱️
#1300 2682 2682 0 0 0 0 31.2s

Insights

Average Tests per Run Total Flaky Tests Total Failed Slowest Test (p95)
2682 0 0 6.1s

Slowest Tests

Test 📝 Results 📊 Duration (avg) ⏱️ Duration (p95) ⏱️
TestDockerExecutor_Build_ContextCancellation 1 6.1s 6.1s
eldritch-libsys: std::dll_inject_impl::tests::test_dll_inject_simple 1 5.2s 5.2s
TestInteractiveShell 1 5.1s 5.1s
TestOtherStreamOutput 1 5.1s 5.1s
imix::bin/imix: install::tests::test_install_execution 3 1.6s 4.5s
imix::bin/imix: install::tests::test_install_execution 3 1.6s 4.5s
imix::bin/imix: install::tests::test_install_execution 3 1.6s 4.5s
imix::bin/imix: tests::task_tests::test_task_streaming_output 3 3.0s 3.0s
imix::bin/imix: tests::task_tests::test_task_streaming_output 3 3.0s 3.0s
imix::bin/imix: tests::task_tests::test_task_streaming_output 3 3.0s 3.0s

🎉 No failed tests in this run. | 🍂 No flaky tests in this run.

Github Test Reporter by CTRF 💚

🔄 This comment has been updated

google-labs-jules bot and others added 3 commits February 26, 2026 05:25
- Created `generate-docs.js` script to parse Eldritch documentation from markdown.
- Integrated doc generation into `npm start` and `npm build`.
- Implemented `DocTooltip` component using `react-markdown` for rendering formatted descriptions.
- Updated `useShellTerminal` to detect words under cursor and fetch documentation.
- Updated `ShellTerminal` to render tooltips on hover.
- Updated `ShellCompletions` to display info icon and tooltips for completion items.

Co-authored-by: KCarretto <16250309+KCarretto@users.noreply.github.com>
- Created `generate-docs.js` script to parse Eldritch documentation from markdown.
- Integrated doc generation into `npm start` and `npm build`.
- Implemented `DocTooltip` component using `react-markdown` for rendering formatted descriptions.
- Updated `useShellTerminal` to detect words under cursor and fetch documentation.
- Updated `ShellTerminal` to render tooltips on hover.
- Updated `ShellCompletions` to display info icon and tooltips for completion items using intelligent lookup.

Co-authored-by: KCarretto <16250309+KCarretto@users.noreply.github.com>
- Created `generate-docs.js` script to parse Eldritch documentation from markdown.
- Integrated doc generation into `npm start` and `npm build`.
- Implemented `DocTooltip` component using `react-markdown` for rendering formatted descriptions.
- Updated `useShellTerminal` to detect words under cursor and fetch documentation with stable positioning.
- Updated `ShellTerminal` to render tooltips on hover.
- Updated `ShellCompletions` to display info icon and tooltips for completion items using intelligent lookup.
- Fixed tooltip scrolling and Markdown tab rendering.

Co-authored-by: KCarretto <16250309+KCarretto@users.noreply.github.com>
@KCarretto KCarretto requested a review from hulto February 26, 2026 05:55
@KCarretto KCarretto marked this pull request as ready for review February 26, 2026 05:55
@KCarretto KCarretto enabled auto-merge February 26, 2026 05:56
@KCarretto KCarretto added this pull request to the merge queue Feb 26, 2026
github-merge-queue bot pushed a commit that referenced this pull request Feb 26, 2026
* Add interactive docstring tooltips to ShellV2

- Created `generate-docs.js` script to parse Eldritch documentation from markdown.
- Integrated doc generation into `npm start` and `npm build`.
- Implemented `DocTooltip` component for displaying function signatures and descriptions.
- Updated `useShellTerminal` to detect words under cursor and fetch documentation.
- Updated `ShellTerminal` to render tooltips on hover.
- Updated `ShellCompletions` to display info icon and tooltips for completion items.

Co-authored-by: KCarretto <16250309+KCarretto@users.noreply.github.com>

* Add interactive docstring tooltips to ShellV2

- Created `generate-docs.js` script to parse Eldritch documentation from markdown.
- Integrated doc generation into `npm start` and `npm build`.
- Implemented `DocTooltip` component using `react-markdown` for rendering formatted descriptions.
- Updated `useShellTerminal` to detect words under cursor and fetch documentation.
- Updated `ShellTerminal` to render tooltips on hover.
- Updated `ShellCompletions` to display info icon and tooltips for completion items.

Co-authored-by: KCarretto <16250309+KCarretto@users.noreply.github.com>

* Add interactive docstring tooltips to ShellV2

- Created `generate-docs.js` script to parse Eldritch documentation from markdown.
- Integrated doc generation into `npm start` and `npm build`.
- Implemented `DocTooltip` component using `react-markdown` for rendering formatted descriptions.
- Updated `useShellTerminal` to detect words under cursor and fetch documentation.
- Updated `ShellTerminal` to render tooltips on hover.
- Updated `ShellCompletions` to display info icon and tooltips for completion items using intelligent lookup.

Co-authored-by: KCarretto <16250309+KCarretto@users.noreply.github.com>

* Add interactive docstring tooltips to ShellV2

- Created `generate-docs.js` script to parse Eldritch documentation from markdown.
- Integrated doc generation into `npm start` and `npm build`.
- Implemented `DocTooltip` component using `react-markdown` for rendering formatted descriptions.
- Updated `useShellTerminal` to detect words under cursor and fetch documentation with stable positioning.
- Updated `ShellTerminal` to render tooltips on hover.
- Updated `ShellCompletions` to display info icon and tooltips for completion items using intelligent lookup.
- Fixed tooltip scrolling and Markdown tab rendering.

Co-authored-by: KCarretto <16250309+KCarretto@users.noreply.github.com>

---------

Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
Co-authored-by: KCarretto <16250309+KCarretto@users.noreply.github.com>
@KCarretto KCarretto removed this pull request from the merge queue due to a manual request Feb 26, 2026
@KCarretto KCarretto merged commit 13028b2 into main Feb 26, 2026
9 checks passed
@KCarretto KCarretto deleted the shell-v2-doc-tooltips-2539696344315748681 branch February 26, 2026 06:13
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.

2 participants