]> git.eshelyaron.com Git - sweep.git/commitdiff
DOC: added section "Code Completion" to the manual
authorEshel Yaron <me@eshelyaron.com>
Tue, 25 Oct 2022 10:52:17 +0000 (13:52 +0300)
committerEshel Yaron <me@eshelyaron.com>
Tue, 25 Oct 2022 10:57:59 +0000 (13:57 +0300)
NEWS.org
README.org

index 26ddc7be563f6a0cc08b08ac4a038ca3abe3fca6..083e234b1fbb241f37ebeabc9cfaebe18cf6ee56 100644 (file)
--- a/NEWS.org
+++ b/NEWS.org
@@ -11,6 +11,15 @@ SWI-Prolog in Emacs.
 For further details, please consult the manual:
 <https://eshelyaron.com/sweep.html>.
 
+* Version 0.8.1 on 2022-10-25
+
+** Added completion-at-point for variable names
+
+When point is preceded by a valid Prolog variable name, invoking
+~completion-at-point~ (with ~C-M-i~ or ~M-TAB~) now detects that it needs to
+complete a variable name and provides other variable names that occur
+in the same clause as completion candidates.
+
 * Version 0.8.0 on 2022-10-22
 
 ** New command ~sweeprolog-insert-term-dwim~ in ~sweeprolog-mode~ buffers
index 904fbf7dbb489309ba5ce6ac91d950f4b53a6994..2a8c852c85a66f9cad9c7bd090381aaa9ff6a06a 100644 (file)
@@ -895,6 +895,32 @@ the non-exported predicates defined in the current buffer.  To force
 prompting for a predicate, invoke ~sweeprolog-export-predicate~ with a
 prefix argument (~C-u C-c C-e~).
 
+
+** Code Completion
+:PROPERTIES:
+:CUSTOM_ID: code-completion
+:DESCRIPTION: Auto-completion commands for Prolog code
+:END:
+
+#+CINDEX: code completion
+#+CINDEX: completion-at-point
+#+KINDEX: C-M-i
+#+KINDEX: M-TAB
+~sweeprolog-mode~ empowers Emacs's standard ~completion-at-point~ command,
+bound by default to ~C-M-i~ and ~M-TAB~, with context-aware completion for
+Prolog terms.  For background about completion-at-point in Emacs, see [[info:emacs#Symbol
+Completion][Symbol Completion in the Emacs manual]].
+
+In ~sweeprolog-mode~ buffers, the following enhancements are provided:
+
+- Variable name completion :: If the text before point can be
+  completed to one or more variable names that appear elsewhere in the
+  current clause, ~completion-at-point~ suggests matching variable names
+  as completion candidates.
+- Predicate completion :: If the text before point can be completed to
+  a predicate call, ~completion-at-point~ suggests matching predicates
+  as completion candidates.
+
 ** Context-Based Term Insertion
 :PROPERTIES:
 :CUSTOM_ID: insert-term-at-point