Feat: remote timeout/retry flags documented but not in RemoteArgs#1376
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
This PR updates remote-debugging documentation and VS Code extension docs discoverability, with guidance on request-class-specific timeouts and retries.
Changes:
- Document narrower
--inspect-timeout-ms/--storage-timeout-msusage alongside--timeout-ms. - Add a VS Code extension architecture doc entry to the extension’s “Open Docs” command and reference it from the extension README.
- Mark the “VS Code extension / DAP adapter architecture” roadmap/backlog item as completed.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| man/man1/soroban-debug-remote.1 | Adds guidance about using per-request-class timeouts. |
| extensions/vscode/src/openDocsCommand.ts | Adds a new docs menu item for the VS Code extension architecture. |
| extensions/vscode/README.md | Mentions the extension architecture doc for deeper reading. |
| docs/remote-troubleshooting.md | Refines timeout troubleshooting guidance and fixes table formatting. |
| docs/remote-debugging.md | Clarifies timeout/retry semantics and updates the example to use --timeout-ms. |
| docs/issues/roadmap-priorities.md | Marks I-015 as completed (strikethrough). |
| docs/issues/backlog-100-issues.md | Marks I-015 as completed (strikethrough). |
| Readme.md | Expands the “Request timed out” troubleshooting row with more specific guidance. |
Comments suppressed due to low confidence (1)
man/man1/soroban-debug-remote.1:1
- The phrasing 'only one read-only request class' is a bit unclear in context (there are multiple read-only classes). Consider rewording to something like 'for a specific read-only request class' or 'without increasing timeouts for other requests' to avoid implying only one such class exists.
.ie \n(.g .ds Aq \(aq
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+469
to
+470
| For a deeper dive into the extension architecture, see the VS Code Extension Architecture document. | ||
|
|
Comment on lines
18
to
+25
| description: 'Internal design of the debugger', | ||
| file: 'architecture.md' | ||
| }, | ||
| { | ||
| label: 'VS Code Extension Architecture', | ||
| description: 'Internal design of the DAP adapter', | ||
| file: 'architecture-vscode.md' | ||
| }, |
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
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.
Closes #697
Fixed Issue #697