From: Eli Zaretskii Date: Sun, 12 Sep 2021 16:51:06 +0000 (+0300) Subject: Fix quoting style in Lisp comments X-Git-Tag: emacs-28.0.90~1038 X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=ff4de1bd88b8be4a7071884910ff601eb10fbad5;p=emacs.git Fix quoting style in Lisp comments * lisp/textmodes/rst.el: * lisp/progmodes/elisp-mode.el (elisp--xref-find-definitions): * lisp/org/org.el: * lisp/org/org-list.el (org-list-to-generic): * lisp/org/org-compat.el: * lisp/hexl.el (hexl-ascii-region): * lisp/emacs-lisp/lisp-mode.el: * lisp/calendar/calendar.el: In comments, quote 'like this'. --- diff --git a/lisp/calendar/calendar.el b/lisp/calendar/calendar.el index fd97192c466..ebce2ae3ddb 100644 --- a/lisp/calendar/calendar.el +++ b/lisp/calendar/calendar.el @@ -119,11 +119,11 @@ ;; Calendar has historically relied heavily on dynamic scoping. ;; Concretely, this manifests in the use of references to let-bound variables ;; in Custom vars as well as code in diary files. -;; `eval' is hence the core of the culprit. It's used on: +;; 'eval' is hence the core of the culprit. It's used on: ;; - calendar-date-display-form ;; - calendar-time-display-form ;; - calendar-chinese-time-zone -;; - in cal-dst's there are various calls to `eval' but they seem not to refer +;; - in cal-dst's there are various calls to 'eval' but they seem not to refer ;; to let-bound variables, surprisingly. ;; - calendar-date-echo-text ;; - calendar-mode-line-format diff --git a/lisp/emacs-lisp/lisp-mode.el b/lisp/emacs-lisp/lisp-mode.el index 677da81144f..9bbc7f8bba2 100644 --- a/lisp/emacs-lisp/lisp-mode.el +++ b/lisp/emacs-lisp/lisp-mode.el @@ -624,7 +624,7 @@ Value for `adaptive-fill-function'." (if (looking-at "\\s-+\"[^\n\"]+\"\\s-*$") "")) ;; Maybe this should be discouraged/obsoleted and users should be -;; encouraged to use `lisp-data-mode' instead. +;; encouraged to use 'lisp-data-mode' instead. (defun lisp-mode-variables (&optional lisp-syntax keywords-case-insensitive elisp) "Common initialization routine for lisp modes. diff --git a/lisp/hexl.el b/lisp/hexl.el index f236498288e..3b048ba650f 100644 --- a/lisp/hexl.el +++ b/lisp/hexl.el @@ -93,7 +93,7 @@ as that will override any bit grouping options set here." "Face used in address area of Hexl mode buffer.") (defface hexl-ascii-region - ;; Copied from `header-line'. We used to inherit from it, but that + ;; Copied from 'header-line'. We used to inherit from it, but that ;; looks awful when the headerline is given a variable-pitch font or ;; (even worse) a 3D look. '((((class color grayscale) (background light)) diff --git a/lisp/org/org-compat.el b/lisp/org/org-compat.el index 82611d907af..7f97ac9c2a1 100644 --- a/lisp/org/org-compat.el +++ b/lisp/org/org-compat.el @@ -179,9 +179,9 @@ This is a floating point number if the size is too large for an integer." Case is significant." (string< s1 s2))) -;; The time- functions below translate nil to `current-time' and -;; accept an integer as of Emacs 25. `decode-time' and -;; `format-time-string' accept nil on Emacs 24 but don't accept an +;; The time- functions below translate nil to 'current-time' and +;; accept an integer as of Emacs 25. 'decode-time' and +;; 'format-time-string' accept nil on Emacs 24 but don't accept an ;; integer until Emacs 25. (if (< emacs-major-version 25) (let ((convert diff --git a/lisp/org/org-list.el b/lisp/org/org-list.el index b26e47aba90..ddb47dd190c 100644 --- a/lisp/org/org-list.el +++ b/lisp/org/org-list.el @@ -3355,7 +3355,7 @@ Valid parameters are: (when (and backend (symbolp backend) (not (org-export-get-backend backend))) (user-error "Unknown :backend value")) (unless backend (require 'ox-org)) - ;; When `:raw' property has a non-nil value, turn all objects back + ;; When ':raw' property has a non-nil value, turn all objects back ;; into Org syntax. (when (and backend (plist-get params :raw)) (org-element-map data org-element-all-objects diff --git a/lisp/org/org.el b/lisp/org/org.el index dc56948b533..d03676e3fb9 100644 --- a/lisp/org/org.el +++ b/lisp/org/org.el @@ -19651,15 +19651,15 @@ When BLOCK-REGEXP is non-nil, use this regexp to find blocks." ;; example-block) don't accept comments. Usual Emacs comment commands ;; cannot cope with those requirements. Therefore, Org replaces them. -;; Org still relies on `comment-dwim', but cannot trust -;; `comment-only-p'. So, `comment-region-function' and -;; `uncomment-region-function' both point -;; to `org-comment-or-uncomment-region'. Eventually, -;; `org-insert-comment' takes care of insertion of comments at the +;; Org still relies on 'comment-dwim', but cannot trust +;; 'comment-only-p'. So, 'comment-region-function' and +;; 'uncomment-region-function' both point +;; to 'org-comment-or-uncomment-region'. Eventually, +;; 'org-insert-comment' takes care of insertion of comments at the ;; beginning of line. -;; `org-setup-comments-handling' install comments related variables -;; during `org-mode' initialization. +;; 'org-setup-comments-handling' install comments related variables +;; during 'org-mode' initialization. (defun org-setup-comments-handling () (interactive) diff --git a/lisp/progmodes/elisp-mode.el b/lisp/progmodes/elisp-mode.el index 22150c7d825..8befae0dec5 100644 --- a/lisp/progmodes/elisp-mode.el +++ b/lisp/progmodes/elisp-mode.el @@ -883,7 +883,7 @@ there are no matches for variables." (secondary-xrefs nil)) ; other xrefs (let ((temp elisp-xref-find-def-functions)) - ;; FIXME: The `elisp-xref-find-def-functions' function interface does + ;; FIXME: The 'elisp-xref-find-def-functions' function interface does ;; not allow for namespace filtering so we tacitly assume they all match. (while (and (null xrefs) temp) diff --git a/lisp/textmodes/rst.el b/lisp/textmodes/rst.el index 46654b6076d..ed1d721f82c 100644 --- a/lisp/textmodes/rst.el +++ b/lisp/textmodes/rst.el @@ -2444,7 +2444,7 @@ PREFER-ROMAN roman numbering is preferred over using letters." tab)) ;; FIXME: At least the continuation may be folded into -;; `newline-and-indent'. However, this may not be wanted by everyone so +;; 'newline-and-indent'. However, this may not be wanted by everyone so ;; it should be possible to switch this off. (defun rst-insert-list (&optional prefer-roman) ;; testcover: ok. @@ -2915,7 +2915,7 @@ error if there is no working link at the given position." (pop-to-buffer (marker-buffer mrkr)) (goto-char mrkr) ;; FIXME: Should be a customizable number of lines from beginning or end of - ;; window just like the argument to `recenter'. It would be ideal if + ;; window just like the argument to 'recenter'. It would be ideal if ;; the adornment is always completely visible. (recenter 5))) @@ -2995,7 +2995,7 @@ burying it." (define-derived-mode rst-toc-mode special-mode "ReST-TOC" "Major mode for output from \\[rst-toc], the table-of-contents for the document. \\{rst-toc-mode-map}" - ;; FIXME: `revert-buffer-function' must be defined so `revert-buffer' works + ;; FIXME: 'revert-buffer-function' must be defined so 'revert-buffer' works ;; as expected for a special mode. In particular the referred buffer ;; needs to be rescanned and the TOC must be updated accordingly. ;; FIXME: Should contain the name of the buffer this is the toc of. @@ -3217,7 +3217,7 @@ Return a list of tabs sorted by likeliness to continue writing like `rst-line-tabs'. Nearer lines have generally a higher likeliness than farther lines. Return nil if no tab is found in the text above." - ;; FIXME: See test `indent-for-tab-command-BUGS'. + ;; FIXME: See test 'indent-for-tab-command-BUGS'. (save-excursion (goto-char pt) (let (leftmost ; Leftmost column found so far.