From: Eli Zaretskii <eliz@gnu.org>
Date: Wed, 20 Mar 2024 14:08:15 +0000 (+0200)
Subject: ; Minor copyedits of last change.
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=c3e6e2153d801924fc8174a4b0c4ee32cc00b6d6;p=emacs.git

; Minor copyedits of last change.

(cherry picked from commit ae9d8eedfdd6030a082010ac933b4aa4ddc05749)
---

diff --git a/lisp/emacs-lisp/comp.el b/lisp/emacs-lisp/comp.el
index 7e8d4e15e0a..1df1e3b3ddb 100644
--- a/lisp/emacs-lisp/comp.el
+++ b/lisp/emacs-lisp/comp.el
@@ -3010,24 +3010,25 @@ These are substituted with a normal `set' op."
 
 ;;; Sanitizer pass specific code.
 
-;; This pass aims to verify compile time value type predictions during
-;; execution.
+;; This pass aims to verify compile-time value-type predictions during
+;; execution of the code.
 ;; The sanitizer pass injects a call to 'helper_sanitizer_assert' before
-;; each conditional branch. 'helper_sanitizer_assert' will verify that
+;; each conditional branch.  'helper_sanitizer_assert' will verify that
 ;; the variable tested by the conditional branch is of the predicted
-;; value type and signal an error otherwise.
+;; value type, or signal an error otherwise.
 
 ;;; Example:
-;; Assuming we want to compile 'test.el' and test function `foo' defined
-;; into it.
 
-;; Native compile 'test.el' instrumenting it for sanitizer usage.
-;; (let ((comp-sanitizer-emit t))
-;;   (load (native-compile "test.el")))
+;; Assume we want to compile 'test.el' and test the function `foo'
+;; defined in it.  Then:
 
-;; Run `foo' with the sanitizer active.
-;; (let ((comp-sanitizer-active t))
-;;   (foo))
+;;  - Native-compile 'test.el' instrumenting it for sanitizer usage:
+;;      (let ((comp-sanitizer-emit t))
+;;        (load (native-compile "test.el")))
+
+;;  - Run `foo' with the sanitizer active:
+;;      (let ((comp-sanitizer-active t))
+;;        (foo))
 
 (defvar comp-sanitizer-emit nil
   "Gates the sanitizer pass.