Skip to content

Commit b104f15

Browse files
committed
Update prompt templates and placeholders in README documentation
1 parent 0816aa8 commit b104f15

1 file changed

Lines changed: 25 additions & 11 deletions

File tree

‎README.md‎

Lines changed: 25 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -43,49 +43,63 @@ _Accurate and fast multi-file edits in a single response._
4343

4444
```
4545
# Files
46-
[full contents of selected files with paths]
46+
47+
[SELECTED FILES]
4748
4849
# Output formatting
49-
[edit format instructions]
50+
Whenever showing a new, updated, renamed, or deleted file, provide a brief explanation, then print the path in a markdown heading (e.g. ### New file: `src/examples/hello.py`, ### Updated file: `src/examples/hello.py`, ### Renamed file: `src/examples/hello.py` (old) `src/welcome.py` (new), ### Deleted file: `src/examples/hello.py`), followed by a markdown code block showing the original and updated code snippets with Git-style merge conflict syntax. Example:
51+
52+
[EXAMPLE]
5053
5154
---
5255
53-
[prompt]
56+
[PROMPT]
5457
```
5558

5659
</details>
5760

5861
<details>
5962
<summary><strong>Ask about files</strong></summary>
6063

61-
_Get help with whatever you're up to._
64+
_Plan features or get explanations._
6265

6366
```
6467
# Files
65-
[full contents of selected files with paths]
68+
69+
[SELECTED FILES]
6670
6771
---
6872
69-
[prompt]
73+
[PROMPT]
7074
```
7175

7276
</details>
7377

7478
<details>
7579
<summary><strong>Code at cursor</strong></summary>
7680

77-
_TAB completions from SOTA reasoning models._
81+
_Quality TAB completions from SOTA reasoning models._
7882

7983
````
8084
# Files
81-
[full contents of selected files with paths]
8285
83-
- File: `[active file]`
86+
[SELECTED FILES]
87+
88+
- File `[ACTIVE FILE PATH]`:
89+
8490
```
85-
[code before cursor]<missing_text>[prompt]</missing_text>[code after cursor]
91+
[PREFIX]<missing_text>[PROMPT]</missing_text>[SUFFIX]
8692
```
8793
88-
[instructions for the missing text]
94+
# Output formatting
95+
96+
Your response must begin with a markdown heading identifying the file and the cursor position, followed by a markdown code block containing the replacement text, followed by a brief explanation. The heading must be: "### Code at cursor: `[ACTIVE FILE PATH]` (ROW:COL)". Always refer to the symbol "<missing_text>" as "cursor position" and "replacement" as "completion". Example:
97+
98+
[EXAMPLE]
99+
100+
---
101+
102+
Find correct replacement text for the <missing_text> symbol.
89103
````
90104

91105
</details>

0 commit comments

Comments
 (0)