Use the term "edit prediction" over "inline completion" (#24211)

Note that this does *not* involve any breaking code changes.

cc @0xtimsb - I didn't change any settings or anything here. That can
happen separately!

Release Notes:

- N/A
This commit is contained in:
Richard Feldman 2025-02-04 13:33:01 -05:00 committed by GitHub
parent c64b26110c
commit 667396c44b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
12 changed files with 56 additions and 56 deletions

View file

@ -3,7 +3,7 @@
Zed supports two sources for completions:
1. "Code Completions" provided by Language Servers (LSPs) automatically installed by Zed or via [Zed Language Extensions](languages.md).
2. "Inline Completions" provided by external APIs like [GitHub Copilot](#github-copilot) or [Supermaven](#supermaven).
2. "Edit Predictions" provided by external APIs like [GitHub Copilot](#github-copilot) or [Supermaven](#supermaven).
## Code Completions
@ -20,7 +20,7 @@ For more information, see:
- [Configuring Supported Languages](./configuring-languages.md)
- [List of Zed Supported Languages](./languages.md).
## Configuring Inline Completions
## Configuring Edit Predictions
### GitHub Copilot
@ -50,17 +50,17 @@ To use Supermaven, add the following to your `settings.json`:
You should be able to sign-in to Supermaven by clicking on the Supermaven icon in the status bar and following the setup instructions.
## Using Inline completions
## Using Edit Predictions
Once you have configured an Inline Completions provider, you can start using inline completions in your code. Inline completions will appear as you type, and you can accept them by pressing `tab` or `enter` or hide them by pressing `esc`.
Once you have configured an Edit Prediction provider, you can start using edit predictions completions in your code. Edit predictions will appear as you type, and you can accept them by pressing `tab` or `enter` or hide them by pressing `esc`.
There are a number of actions/shortcuts available to interact with inline completions:
There are a number of actions/shortcuts available to interact with edit predictions:
- `editor: accept inline completion` (`tab`): To accept the current inline completion
- `editor: accept partial inline completion` (`ctrl-cmd-right`): To accept the current inline completion up to the next word boundary
- `editor: show inline completion` (`alt-tab`): Trigger an inline completion request manually
- `editor: next inline completion` (`alt-tab`): To cycle to the next inline completion
- `editor: previous inline completion` (`alt-shift-tab`): To cycle to the previous inline completion
- `editor: accept inline completion` (`tab`): To accept the current edit prediction
- `editor: accept partial inline completion` (`ctrl-cmd-right`): To accept the current edit prediction up to the next word boundary
- `editor: show inline completion` (`alt-tab`): Trigger an edit prediction request manually
- `editor: next inline completion` (`alt-tab`): To cycle to the next edit prediction
- `editor: previous inline completion` (`alt-shift-tab`): To cycle to the previous edit prediction
### Disabling Inline-Completions
@ -72,9 +72,9 @@ To disable completions that appear automatically as you type, add the following
}
```
You can trigger inline completions manually by executing `editor: show inline completion` (`alt-tab`).
You can trigger edit predictions manually by executing `editor: show inline completion` (`alt-tab`).
You can also add this as a language-specific setting in your `settings.json` to disable inline completions for a specific language:
You can also add this as a language-specific setting in your `settings.json` to disable edit predictions for a specific language:
```json
{

View file

@ -375,9 +375,9 @@ There are two options to choose from:
1. `shell_hook`: Use the shell hook to load direnv. This relies on direnv to activate upon entering the directory. Supports POSIX shells and fish.
2. `direct`: Use `direnv export json` to load direnv. This will load direnv directly without relying on the shell hook and might cause some inconsistencies. This allows direnv to work with any shell.
## Inline Completions
## Edit Predictions
- Description: Settings for inline completions.
- Description: Settings for edit predictions.
- Setting: `inline_completions`
- Default:
@ -398,7 +398,7 @@ There are two options to choose from:
### Disabled Globs
- Description: A list of globs representing files that inline completions should be disabled for.
- Description: A list of globs representing files that edit predictions should be disabled for.
- Setting: `disabled_globs`
- Default: `[".env"]`
@ -406,9 +406,9 @@ There are two options to choose from:
List of `string` values
## Inline Completions Disabled in
## Edit Predictions Disabled in
- Description: A list of language scopes in which inline completions should be disabled.
- Description: A list of language scopes in which edit predictions should be disabled.
- Setting: `inline_completions_disabled_in`
- Default: `[]`
@ -416,19 +416,19 @@ List of `string` values
List of `string` values
1. Don't show inline completions in comments:
1. Don't show edit predictions in comments:
```json
"disabled_in": ["comment"]
```
2. Don't show inline completions in strings and comments:
2. Don't show edit predictions in strings and comments:
```json
"disabled_in": ["comment", "string"]
```
3. Only in Go, don't show inline completions in strings and comments:
3. Only in Go, don't show edit predictions in strings and comments:
```json
{
@ -1652,9 +1652,9 @@ Or to set a `socks5` proxy:
`boolean` values
## Show Inline Completions
## Show Edit Predictions
- Description: Whether to show inline completions as you type or manually by triggering `editor::ShowInlineCompletion`.
- Description: Whether to show edit predictions as you type or manually by triggering `editor::ShowInlineCompletion`.
- Setting: `show_inline_completions`
- Default: `true`