branch: elpa/magit
commit 330819de3e9c1f8f902a8816d1d53021474f6d30
Author: Jonas Bernoulli <jo...@bernoul.li>
Commit: Jonas Bernoulli <jo...@bernoul.li>
Symbol-quote booleans in more docstrings
This was forbidden until recently, and I'll need some time to develop
my personal preference, now that the dogma is gone. For now I symbol-
quote booleans in docstrings, if they appear in a list of symbols,
which include non-booleans. For local consistency, I quote all
appearances within a docstring, not just those in the list.
Don't quote "nil" in "non-nil". And if booleans appear in a docstring
but never within some kind of listing, then I don't quote them either.
This is a follow up to [1: ea811b143b].
1: 2025-02-25 ea811b143b41a217cffe5d980d150437dddc4cef
Symbol-quote booleans even in docstrings
---
lisp/magit-diff.el | 28 ++++++++++++++--------------
1 file changed, 14 insertions(+), 14 deletions(-)
diff --git a/lisp/magit-diff.el b/lisp/magit-diff.el
index cd36b63053..886877080e 100644
--- a/lisp/magit-diff.el
+++ b/lisp/magit-diff.el
@@ -193,8 +193,8 @@ keep their distinct foreground colors."
(defcustom magit-diff-refine-hunk nil
"Whether to show word-granularity differences within diff hunks.
-nil Never show fine differences.
-t Show fine differences for the current diff hunk only.
+`nil' Never show fine differences.
+`t' Show fine differences for the current diff hunk only.
`all' Show fine differences for all displayed diff hunks."
:group 'magit-diff
:safe (lambda (val) (memq val '(nil t all)))
@@ -217,13 +217,13 @@ t Show fine differences for the current diff hunk
only.
Determining the correct width can be expensive if it requires
opening large and/or many files, so the widths are cached in
-the variable `magit-diff--tab-width-cache'. Set that to nil
+the variable `magit-diff--tab-width-cache'. Set that to `nil'
to invalidate the cache.
-nil Never adjust tab width. Use `tab-width's value from
+`nil' Never adjust tab width. Use `tab-width's value from
the Magit buffer itself instead.
-t If the corresponding file-visiting buffer exits, then
+`t' If the corresponding file-visiting buffer exits, then
use `tab-width's value from that buffer. Doing this is
cheap, so this value is used even if a corresponding
cache entry exists.
@@ -243,8 +243,8 @@ NUMBER Like `always', but don't visit files larger than
NUMBER
(defcustom magit-diff-paint-whitespace t
"Specify where to highlight whitespace errors.
-nil Never highlight whitespace errors.
-t Highlight whitespace errors everywhere.
+`nil' Never highlight whitespace errors.
+`t' Highlight whitespace errors everywhere.
`uncommitted' Only highlight whitespace errors in diffs
showing uncommitted changes.
@@ -266,7 +266,7 @@ whitespace errors are highlighted."
(defcustom magit-diff-paint-whitespace-lines t
"Specify in what kind of lines to highlight whitespace errors.
-t Highlight only in added lines.
+`t' Highlight only in added lines.
`both' Highlight in added and removed lines.
`all' Highlight in added, removed and context lines."
:package-version '(magit . "3.0.0")
@@ -437,7 +437,7 @@ and the supported values for each key being:
`t' Show these related branches.
Keys which are not present in the alist have an implicit value `t'
-\(so the default alist value of nil means all related branch types
+\(so the default alist value of `nil' means all related branch types
will be shown.)
The types to be shown are additionally subject to user option
@@ -465,7 +465,7 @@ performance and reliability:
long and which contain at least one number as well as at least
one letter.
-If nil, then no hashes are turned into sections, but you can
+If `nil', then no hashes are turned into sections, but you can
still visit the commit at point using \"RET\"."
:package-version '(magit . "2.12.0")
:group 'magit-revision
@@ -478,9 +478,9 @@ still visit the commit at point using \"RET\"."
(defcustom magit-revision-show-gravatars nil
"Whether to show gravatar images in revision buffers.
-If nil, then don't insert any gravatar images. If t, then insert
-both images. If `author' or `committer', then insert only the
-respective image.
+If `nil', then don't insert any gravatar images. If `t', then
+insert both images. If `author' or `committer', then insert
+only the respective image.
If you have customized the option `magit-revision-header-format'
and want to insert the images then you might also have to specify
@@ -489,7 +489,7 @@ two regular expressions. The car specifies where to insert
the
author's image. The top half of the image is inserted right
after the matched text, the bottom half on the next line in the
same column. The cdr specifies where to insert the committer's
-image, accordingly. Either the car or the cdr may be nil."
+image, accordingly. Either the car or the cdr may be `nil'."
:package-version '(magit . "2.3.0")
:group 'magit-revision
:type '(choice
