]> git.eshelyaron.com Git - sweep.git/commitdiff
* README.org (Example Usage Comments): improve wording
authorEshel Yaron <me@eshelyaron.com>
Thu, 1 Jun 2023 11:21:09 +0000 (14:21 +0300)
committerEshel Yaron <me@eshelyaron.com>
Thu, 1 Jun 2023 11:21:09 +0000 (14:21 +0300)
README.org

index 6d43662cd542255561cd8fa2f50268ce9d5f135d..b60705c3be1710c870423758b49fa9c2ad85536a 100644 (file)
@@ -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