diff options
| author | Pascal Kuthe | 2023-04-07 12:50:47 +0000 |
|---|---|---|
| committer | Blaž Hrastnik | 2023-05-18 06:16:50 +0000 |
| commit | 6842fd4c36c5855023b007a36b0b5c8bd965d8de (patch) | |
| tree | 4af253f71b873eadc23bc33bfc69d88024bdef46 | |
| parent | 28b730381cc93d06e5a090b8734505edbebb1af4 (diff) | |
clarify comments about completion savepoints
Co-authored-by: Michael Davis <mcarsondavis@gmail.com>
| -rw-r--r-- | helix-term/src/ui/completion.rs | 14 | ||||
| -rw-r--r-- | helix-view/src/document.rs | 2 | ||||
| -rw-r--r-- | helix-view/src/editor.rs | 2 |
3 files changed, 9 insertions, 9 deletions
diff --git a/helix-term/src/ui/completion.rs b/helix-term/src/ui/completion.rs index c736f043..c5c40580 100644 --- a/helix-term/src/ui/completion.rs +++ b/helix-term/src/ui/completion.rs @@ -226,14 +226,14 @@ impl Completion { match event { PromptEvent::Abort => {} PromptEvent::Update => { - // Update creates "ghost" transactiosn which are not send to the - // lsp server to avoid messing up rerequesting completions. Once a - // completion has been selected (with) tab it's always accepted whenever anything + // Update creates "ghost" transactions which are not sent to the + // lsp server to avoid messing up re-requesting completions. Once a + // completion has been selected (with tab, c-n or c-p) it's always accepted whenever anything // is typed. The only way to avoid that is to explicitly abort the completion - // with esc/c-c. This will remove the "ghost" transaction. + // with c-c. This will remove the "ghost" transaction. // - // The ghost transaction is modeled with a transaction that is not send to the LS. - // (apply_temporary) and a savepoint. It's extremly important this savepoint is restored + // The ghost transaction is modeled with a transaction that is not sent to the LS. + // (apply_temporary) and a savepoint. It's extremely important this savepoint is restored // (also without sending the transaction to the LS) *before any further transaction is applied*. // Otherwise incremental sync breaks (since the state of the LS doesn't match the state the transaction // is applied to). @@ -293,7 +293,7 @@ impl Completion { changes: completion_changes(&transaction, trigger_offset), }); - // TOOD: add additional _edits to completion_changes? + // TODO: add additional _edits to completion_changes? if let Some(additional_edits) = item.item.additional_text_edits { if !additional_edits.is_empty() { let transaction = util::generate_transaction_from_edits( diff --git a/helix-view/src/document.rs b/helix-view/src/document.rs index 4d8e61e1..e29e52cc 100644 --- a/helix-view/src/document.rs +++ b/helix-view/src/document.rs @@ -1197,7 +1197,7 @@ impl Document { self.apply_inner(transaction, view_id, true) } - /// Apply a [`Transaction`] to the [`Document`] to change its text. + /// Apply a [`Transaction`] to the [`Document`] to change its text /// without notifying the language servers. This is useful for temporary transactions /// that must not influence the server. pub fn apply_temporary(&mut self, transaction: &Transaction, view_id: ViewId) -> bool { diff --git a/helix-view/src/editor.rs b/helix-view/src/editor.rs index 43227c5f..9546d460 100644 --- a/helix-view/src/editor.rs +++ b/helix-view/src/editor.rs @@ -911,7 +911,7 @@ pub enum CompleteAction { trigger_offset: usize, changes: Vec<Change>, }, - /// A savepoint of the currently active completion. The completion + /// A savepoint of the currently selected completion. The savepoint /// MUST be restored before sending any event to the LSP Selected { savepoint: Arc<SavePoint> }, } |