docs: update documentation for diff mode

hashcacher · Aug 6, 2024 · 5bf8814 · 5bf8814
1 parent afd7b08
commit 5bf8814
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -165,9 +165,9 @@ codewhisper list-models
 # CodeWhisper will prompt you to select a model from the list of available models
 codewhisper task
 
-# To disable the new diff-based code modifications, you can use the following command:
-# This will use full-file code modifications
-codewhisper task --no-diff
+# To enable the new diff-based code modifications, you can use the following command:
+# This will use diff-based code modifications. Please note that this is still experimental and may not work with all models. It is currently only recommended with Claude 3.5 Sonnet.
+codewhisper task --diff
 
 # You can also specify a model directly
 # Claude-3.5 Sonnet

diff --git a/USAGE.md b/USAGE.md
@@ -53,8 +53,8 @@ codewhisper task [options]
 | `-c, --context <paths...>`            | Specify files or directories to include in the task context. Can be file paths, directory paths, or glob patterns. Multiple entries should be space-separated.                                                                                                                                                                                                                |
 | `--github-issue`                      | Use GitHub issue for task input                                                                                                                                                                                                                                                                                                                                               |
 | `--github-issue-filters <filters>`    | Use these filters when fetching issues. Format: comma-separated key:value pairs. Example: labels:p1,assignee:abc Note: see "query parameters" at https://docs.github.com/en/rest/issues/issues?apiVersion=2022-11-28#list-repository-issues--parameters for all options.                                                                                                      |
-| `-df, --diff`                         | Use diff format for file updates instead of full file content (default: true)                                                                                                                                                                                                                                                                                                 |
-| `--no-diff`                           | Disable diff mode (default: false)                                                                                                                                                                                                                                                                                                                                            |
+| `-df, --diff`                         | Use diff format for file updates instead of full file content (default: false). Please note that this is still experimental and may not work with all models. It is currently only recommended with Claude 3.5 Sonnet.                                                                                                                                                        |
+| `--no-diff`                           | Disable diff mode (default: true)                                                                                                                                                                                                                                                                                                                                             |
 | `--plan`                              | Use the planning mode, this generates an intermediate plan, which can be modified. Useful for complex tasks. (default: true)                                                                                                                                                                                                                                                  |
 | `--no-plan`                           | Disable the planning mode. Useful for simple tasks (default: false)                                                                                                                                                                                                                                                                                                           |
 | `-g, --gitignore <path>`              | Path to .gitignore file (default: .gitignore)                                                                                                                                                                                                                                                                                                                                 |