branch: elpa/magit
commit ea811b143b41a217cffe5d980d150437dddc4cef
Author: Jonas Bernoulli <[email protected]>
Commit: Jonas Bernoulli <[email protected]>
Symbol-quote booleans even in docstrings
Well, that wasn't my intention when I did [1: 9914feb4d5], but the right
people saw that, and now it is possible to symbol-quote booleans without
checkdoc complaining about it. :wave:
1: 2025-02-21 9914feb4d5a2feab091076be554d80781594869d
Do not symbol-quote booleans in docstrings
---
.dir-locals.el | 3 ++-
lisp/magit-base.el | 2 +-
lisp/magit-branch.el | 6 +++---
lisp/magit-diff.el | 10 +++++-----
4 files changed, 11 insertions(+), 10 deletions(-)
diff --git a/.dir-locals.el b/.dir-locals.el
index 72fdcd43a48..4f46a2cfa0d 100644
--- a/.dir-locals.el
+++ b/.dir-locals.el
@@ -1,5 +1,6 @@
((emacs-lisp-mode
- (indent-tabs-mode . nil))
+ (indent-tabs-mode . nil)
+ (checkdoc-allow-quoting-nil-and-t . t))
(git-commit-mode
(git-commit-major-mode . git-commit-elisp-text-mode))
(makefile-gmake-mode
diff --git a/lisp/magit-base.el b/lisp/magit-base.el
index 3a17b1464e2..96aba336a9b 100644
--- a/lisp/magit-base.el
+++ b/lisp/magit-base.el
@@ -329,7 +329,7 @@ Various:
Global settings:
Instead of adding all of the above symbols to the value of this
- option you can also set it to the atom t, which has the same
+ option you can also set it to the atom `t', which has the same
effect as adding all of the above symbols. Doing that most
certainly is a bad idea, especially because other symbols might
be added in the future. So even if you don't want to be asked
diff --git a/lisp/magit-branch.el b/lisp/magit-branch.el
index fca914f103c..3411046d620 100644
--- a/lisp/magit-branch.el
+++ b/lisp/magit-branch.el
@@ -38,8 +38,8 @@
(defcustom magit-branch-read-upstream-first t
"Whether to read upstream before name of new branch when creating a branch.
-nil Read the branch name first.
-t Read the upstream first.
+`nil' Read the branch name first.
+`t' Read the upstream first.
`fallback' Read the upstream first, but if it turns out that the chosen
value is not a valid upstream (because it cannot be resolved
as an existing revision), then treat it as the name of the
@@ -177,7 +177,7 @@ When t, then rename the branch named OLD on the remote
specified
remote and unless NEW already exists on the remote.
When `forge-only' and the `forge' package is available, then
- behave like t if the remote points to a repository on a forge
+ behave like `t' if the remote points to a repository on a forge
(currently Github or Gitlab), otherwise like `local-only'."
:package-version '(magit . "2.90.0")
:group 'magit-commands
diff --git a/lisp/magit-diff.el b/lisp/magit-diff.el
index bf47e03c877..cd36b63053d 100644
--- a/lisp/magit-diff.el
+++ b/lisp/magit-diff.el
@@ -412,8 +412,8 @@ subject to option `magit-revision-insert-related-refs'."
(defcustom magit-revision-insert-related-refs t
"Whether to show related branches in revision buffers.
-nil Don't show any related branches.
-t Show related local branches.
+`nil' Don't show any related branches.
+`t' Show related local branches.
`all' Show related local and remote branches.
`mixed' Show all containing branches and local merged branches.
@@ -433,10 +433,10 @@ This is an alist, with recognised keys being the symbols
`parents', `merged', `contained', `follows', and `precedes';
and the supported values for each key being:
-nil Hide these related branches.
-t Show these related branches.
+`nil' Hide these related branches.
+`t' Show these related branches.
-Keys which are not present in the alist have an implicit value t
+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
will be shown.)
