branch: elpa/sweeprolog
commit ed829f4a1f8ee1b140b58c590dd74dd1bd85dde1
Author: Eshel Yaron <m...@eshelyaron.com>
Commit: Eshel Yaron <m...@eshelyaron.com>
* README.org (Example Usage Comments): improve wording
---
README.org | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/README.org b/README.org
index 6d43662cd5..b60705c3be 100644
--- a/README.org
+++ b/README.org
@@ -1519,12 +1519,12 @@ SWI-Prolog, see
[[https://www.swi-prolog.org/pldoc/doc_for?object=section(%27pac
:END:
Beyond documenting your code with =PlDoc= comments as described in
-[[#sweeprolog-pldoc][Documenting Predicates]], you might want to have comments
in your source
-code that shows example usage of some predicate. Creating such
-comments usually involves posting queries in a Prolog top-level,
-copying the queries and their results into the relevant source code
-buffer, and formatting them as comments. Sweep provides the following
-command to streamline this process:
+[[#sweeprolog-pldoc][Documenting Predicates]], you may want to have comments
in your source
+code that demonstrate example usage of some predicate or another.
+Creating such comments usually involves posting queries in a Prolog
+top-level, copying the queries and their results into the relevant
+source code buffer, and formatting them as comments. Sweep provides
+the following command to streamline this process:
#+FINDEX: sweeprolog-make-example-usage-comment
- Key: C-c C-% (sweeprolog-make-example-usage-comment) :: Start a
