From: Eshel Yaron Date: Thu, 1 Jun 2023 11:21:09 +0000 (+0300) Subject: * README.org (Example Usage Comments): improve wording X-Git-Tag: V9.1.10-sweep-0.18.4~10 X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=ed829f4a1f8ee1b140b58c590dd74dd1bd85dde1;p=sweep.git * README.org (Example Usage Comments): improve wording --- diff --git a/README.org b/README.org index 6d43662..b60705c 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