update README to include new command execution tool#11
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR updates the documentation to reflect the new command execution tool for interacting with SwitchBot devices by replacing the outdated "turn_on_off_device" with "execute_command" in both English and Japanese README files.
- Updated the tool description and names in README.md.
- Made corresponding changes in README_ja.md.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Revised the available tools description and table to match new command execution capability. |
| README_ja.md | Updated Japanese documentation to reflect the new tool and functionality. |
| ## Available Tools | ||
|
|
||
| Currently, only a few tools are available, such as retrieving devices, retrieving statuses, and executing ON/OFF commands. | ||
| Retrieving devices, retrieving statuses, and executing commands on devices are available. |
There was a problem hiding this comment.
[nitpick] Consider adding a brief note that the 'execute_command' tool supports a broader set of functionalities beyond simple power control to ensure clarity for users.
| ## 利用可能なツール | ||
|
|
||
| 現在はデバイスの取得とステータスの取得、ON/OFFコマンドの実行の一部ツールのみが利用可能です。 | ||
| デバイスの取得とステータスの取得、デバイスのコマンドの実行が利用可能です。 |
There was a problem hiding this comment.
[nitpick] Verify that the Japanese documentation clearly communicates the expanded capabilities of the 'execute_command' tool, aligning with the updates in README.md.
Code Metrics Report
Details | | main (1e622dc) | #11 (e1874db) | +/- |
|---------------------|----------------|---------------|------|
| Coverage | 69.6% | 69.6% | 0.0% |
| Files | 3 | 3 | 0 |
| Lines | 99 | 99 | 0 |
| Covered | 69 | 69 | 0 |
| Code to Test Ratio | 1:1.7 | 1:1.7 | 0.0 |
| Code | 206 | 206 | 0 |
| Test | 353 | 353 | 0 |
- | Test Execution Time | 26s | 28s | +2s |Reported by octocov |
This pull request updates the documentation in both
README.mdandREADME_ja.mdto reflect changes in the available tools for interacting with SwitchBot devices. The updates clarify the functionality and improve consistency in the descriptions.Documentation updates:
README.md: Updated the description of available tools to clarify that commands can now be executed on devices, and replacedturn_on_off_devicewithexecute_commandin the tools list.README_ja.md: Made similar updates in the Japanese documentation, reflecting the ability to execute commands on devices and replacingturn_on_off_devicewithexecute_command.