docs: Minor tidying of docstrings and tool descriptions#228
Conversation
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting
| const hasDebriefCommands = this._containsDebriefCommands(result); | ||
|
|
||
| if (hasDebriefCommands) { | ||
| const successMessage = `Tool "${commandName}" executed successfully and plot updated`; | ||
| vscode.window.showInformationMessage(successMessage); | ||
| // Tool updated plot - no notification needed on success | ||
| console.warn(`[DebriefActivityProvider] Tool "${commandName}" executed successfully and plot updated`); | ||
| } else { | ||
| const successMessage = `Tool "${commandName}" executed successfully`; | ||
| vscode.window.showInformationMessage( | ||
| successMessage, | ||
| 'View Results', | ||
| 'Copy Results' | ||
| ).then(selection => { | ||
| if (selection === 'View Results') { | ||
| void this._showToolResults(commandName, result); | ||
| } else if (selection === 'Copy Results') { | ||
| void this._copyToolResults(result); | ||
| } | ||
| }); | ||
| // Tool returned data - log success (no notification on success) | ||
| console.warn(`[DebriefActivityProvider] Tool "${commandName}" executed successfully`); | ||
| // Users can access results through the Activity view if needed | ||
| } |
There was a problem hiding this comment.
The previous implementation showed an information message with View Results/Copy Results actions whenever a tool returned data. This change replaces that dialog with a console.warn, so _showToolResults and _copyToolResults are no longer invoked anywhere. As a result, users have no UI to open or copy the tool output after execution and the data is effectively inaccessible unless they inspect logs. This is a functional regression rather than a documentation tweak.
Useful? React with 👍 / 👎.
| const hasDebriefCommands = this._containsDebriefCommands(result); | ||
|
|
||
| if (hasDebriefCommands) { | ||
| // If tool returned commands, those were processed by GlobalController | ||
| const successMessage = `Tool "${commandName}" executed successfully and plot updated`; | ||
| vscode.window.showInformationMessage(successMessage); | ||
| // Tool updated plot - no notification needed on success | ||
| console.warn(`[DebriefOutlineProvider] Tool "${commandName}" executed successfully and plot updated`); | ||
| } else { | ||
| // Traditional result handling for tools that return data | ||
| const successMessage = `Tool "${commandName}" executed successfully`; | ||
| vscode.window.showInformationMessage( | ||
| successMessage, | ||
| 'View Results', | ||
| 'Copy Results' | ||
| ).then(selection => { | ||
| if (selection === 'View Results') { | ||
| this._showToolResults(commandName, result); | ||
| } else if (selection === 'Copy Results') { | ||
| this._copyToolResults(result); | ||
| } | ||
| }); | ||
| // Tool returned data - log success (no notification on success) | ||
| console.warn(`[DebriefOutlineProvider] Tool "${commandName}" executed successfully`); | ||
| // Users can access results through the Outline view if needed | ||
| } |
There was a problem hiding this comment.
Similar to the activity provider, the outline provider previously surfaced a notification with View Results/Copy Results when a tool returned data. The new code logs to the console instead, leaving _showToolResults and _copyToolResults unused and giving users no way to inspect or copy results from the outline view. This removes a core piece of functionality and likely wasn’t intended in a commit described as documentation cleanup.
Useful? React with 👍 / 👎.
🔧 Tool Vault Build CompleteCommit: cc9ec0f The Tool Vault packager has been built and tested successfully. |
🚀 VS Code Extension PR Preview DeployedYour VS Code extension PR preview has been successfully deployed to Fly.io! 🌐 Preview URL: https://pr-228-futuredebrief.fly.dev 📋 Details:
🔧 What's included:
💡 How to use:
This preview will be automatically updated when you push new commits to this PR. |
- Deleted PropertiesViewProvider.ts and TimeControllerProvider.ts files to streamline the codebase and eliminate unused components. - Removed associated state management and event handling logic to consolidate state management within the GlobalController. - Updated documentation to reflect the removal of these components and their functionalities.
🔧 Tool Vault Build CompleteCommit: fe3e03a The Tool Vault packager has been built and tested successfully. |
🧹 Tool Vault Cleanup CompleteThe preview Fly.io app |
🧹 VS Code Extension PR Preview Cleaned UpYour PR preview environment has been automatically destroyed. ✅ Cleanup successful!
All associated resources have been removed from Fly.io to optimize costs. |
1 participant
Summary
Test plan