branch: elpa/magit
commit d4fdadc127d3d8b98e71d38675bb0438c6ae93f1
Author: Jonas Bernoulli <jo...@bernoul.li>
Commit: Jonas Bernoulli <jo...@bernoul.li>
Fix various docstrings
---
lisp/git-commit.el | 2 +-
lisp/git-rebase.el | 10 +++++-----
lisp/magit-blame.el | 5 +++--
lisp/magit-branch.el | 2 +-
lisp/magit-commit.el | 16 ++++++++--------
lisp/magit-diff.el | 2 +-
lisp/magit-git.el | 4 ++--
lisp/magit-mode.el | 2 +-
lisp/magit-refs.el | 2 +-
lisp/magit-stash.el | 2 +-
lisp/magit.el | 20 ++++++++++----------
11 files changed, 34 insertions(+), 33 deletions(-)
diff --git a/lisp/git-commit.el b/lisp/git-commit.el
index 1c62cd3b55..b0f3e6ae21 100644
--- a/lisp/git-commit.el
+++ b/lisp/git-commit.el
@@ -434,7 +434,7 @@ the redundant bindings, then set this to nil, before loading
(require 'easymenu)
(easy-menu-define git-commit-mode-menu git-commit-mode-map
- "Git Commit Mode Menu"
+ "Git Commit Mode Menu."
'("Commit"
["Previous" git-commit-prev-message t]
["Next" git-commit-next-message t]
diff --git a/lisp/git-rebase.el b/lisp/git-rebase.el
index 540932ebc9..d2d9ef10bd 100644
--- a/lisp/git-rebase.el
+++ b/lisp/git-rebase.el
@@ -181,7 +181,7 @@
(put 'git-rebase-kill-line :advertised-binding (kbd "k"))
(easy-menu-define git-rebase-mode-menu git-rebase-mode-map
- "Git-Rebase mode menu"
+ "Git-Rebase mode menu."
'("Rebase"
["Pick" git-rebase-pick t]
["Reword" git-rebase-reword t]
@@ -787,10 +787,10 @@ running \"man git-rebase\" at the command line) for
details."
(1 'git-rebase-label t))))
(defun git-rebase-mode-show-keybindings ()
- "Modify the \"Commands:\" section of the comment Git generates
-at the bottom of the file so that in place of the one-letter
-abbreviation for the command, it shows the command's keybinding.
-By default, this is the same except for the \"pick\" command."
+ "Modify the \"Commands:\" section of the comment Git generates.
+Modify that section to replace Git's one-letter command abbreviation,
+with the key bindings used in Magit. By default, these are the same,
+except for the \"pick\" command."
(let ((inhibit-read-only t))
(save-excursion
(goto-char (point-min))
diff --git a/lisp/magit-blame.el b/lisp/magit-blame.el
index a7ec31d730..3482026d8a 100644
--- a/lisp/magit-blame.el
+++ b/lisp/magit-blame.el
@@ -107,7 +107,7 @@ the background color.
Blame information is displayed using overlays. Such extensive
use of overlays is known to slow down even basic operations, such
-as moving the cursor. To reduce the number of overlays the margin
+as moving the cursor. To reduce the number of overlays the margin
style had to be removed from the default value of this option.
Note that the margin overlays are created even if another style
@@ -883,7 +883,8 @@ then also kill the buffer."
(user-error "No more chunks")))
(defun magit-blame-next-chunk-same-commit (&optional previous)
- "Move to the next chunk from the same commit.\n\n(fn)"
+ "Move to the next chunk from the same commit.
+\n(fn)"
(interactive)
(if-let ((rev (oref (magit-current-blame-chunk) orig-rev)))
(let ((pos (point)) ov)
diff --git a/lisp/magit-branch.el b/lisp/magit-branch.el
index 2693402eec..3d39a6f357 100644
--- a/lisp/magit-branch.el
+++ b/lisp/magit-branch.el
@@ -825,7 +825,7 @@ and also rename the respective reflog file."
;;;###autoload
(defun magit-branch-unshelve (branch)
- "Unshelve a BRANCH
+ "Unshelve a BRANCH.
Rename \"refs/shelved/BRANCH\" to \"refs/heads/BRANCH\",
and also rename the respective reflog file."
(interactive
diff --git a/lisp/magit-commit.el b/lisp/magit-commit.el
index 24a872c0f1..1b0c4fb4b3 100644
--- a/lisp/magit-commit.el
+++ b/lisp/magit-commit.el
@@ -204,7 +204,7 @@ Also see https://github.com/magit/magit/issues/4132.";
"Amend staged changes to the last commit, without editing its message.
With a prefix argument do not update the committer date; without an
-argument update it. The option `magit-commit-extend-override-date'
+argument update it. The option `magit-commit-extend-override-date'
can be used to inverse the meaning of the prefix argument. Called
non-interactively, the optional OVERRIDE-DATE argument controls this
behavior, and the option is of no relevance."
@@ -232,7 +232,7 @@ behavior, and the option is of no relevance."
"Reword the message of the last commit, without amending its tree.
With a prefix argument do not update the committer date; without an
-argument update it. The option `magit-commit-reword-override-date'
+argument update it. The option `magit-commit-reword-override-date'
can be used to inverse the meaning of the prefix argument. Called
non-interactively, the optional OVERRIDE-DATE argument controls this
behavior, and the option is of no relevance."
@@ -582,13 +582,13 @@ See `magit-commit-autofixup' for an alternative
implementation."
(transient-define-prefix magit-commit-autofixup (phase commit args)
"Spread staged or unstaged changes across recent commits.
-If there are any staged then spread only those, otherwise
-spread all unstaged changes. With a prefix argument use a
-transient command to select infix arguments.
+If there are any staged then spread only those, otherwise spread all
+unstaged changes. With a prefix argument use a transient command to
+select infix arguments.
-This command requires the git-autofixup script, which is
-available from https://github.com/torbiak/git-autofixup.
-See `magit-commit-absorb' for an alternative implementation."
+This command requires the git-autofixup script, which is available from
+https://github.com/torbiak/git-autofixup. See `magit-commit-absorb' for
+an alternative implementation."
:value '("-vv")
["Arguments"
(magit-autofixup:--context)
diff --git a/lisp/magit-diff.el b/lisp/magit-diff.el
index 646b5f0048..cd36b63053 100644
--- a/lisp/magit-diff.el
+++ b/lisp/magit-diff.el
@@ -410,7 +410,7 @@ subject to option `magit-revision-insert-related-refs'."
:type 'string)
(defcustom magit-revision-insert-related-refs t
- "Whether to show related branches in revision buffers
+ "Whether to show related branches in revision buffers.
`nil' Don't show any related branches.
`t' Show related local branches.
diff --git a/lisp/magit-git.el b/lisp/magit-git.el
index d1cf573d63..76b976dc6d 100644
--- a/lisp/magit-git.el
+++ b/lisp/magit-git.el
@@ -1463,7 +1463,7 @@ If REFNAME is ambiguous, return nil."
Return an unambiguous refname, either REFNAME or that prefixed
with PREFIX, nil otherwise. If REFNAME has an offset suffix
such as \"~1\", then that is preserved. If optional PREFIX is
-nil, then use \"heads/\". "
+nil, then use \"heads/\"."
(if (magit-ref-ambiguous-p refname)
(let ((refname (concat (or prefix "heads/") refname)))
(and (not (magit-ref-ambiguous-p refname)) refname))
@@ -1873,7 +1873,7 @@ the name of a remote and REF is the ref local to the
remote."
If optional REV is nil, then default to `HEAD'.
If optional WITH-DISTANCE is non-nil then return (TAG COMMITS),
-if it is `dirty' return (TAG COMMIT DIRTY). COMMITS is the number
+if it is `dirty' return (TAG COMMIT DIRTY). COMMITS is the number
of commits in `HEAD' but not in TAG and DIRTY is t if there are
uncommitted changes, nil otherwise."
(and-let* ((str (magit-git-str "describe" "--long" "--tags"
diff --git a/lisp/magit-mode.el b/lisp/magit-mode.el
index b79084280d..567e2d3a8a 100644
--- a/lisp/magit-mode.el
+++ b/lisp/magit-mode.el
@@ -494,7 +494,7 @@ to the kill ring."
'bug-reference-push-button))
(easy-menu-define magit-mode-menu magit-mode-map
- "Magit menu"
+ "Magit menu."
;; Similar to `magit-dispatch' but exclude:
;; - commands that are available from context menus:
;; apply, reverse, discard, stage, unstage,
diff --git a/lisp/magit-refs.el b/lisp/magit-refs.el
index 927dc09680..09eb881848 100644
--- a/lisp/magit-refs.el
+++ b/lisp/magit-refs.el
@@ -247,7 +247,7 @@ the outcome.
and lists of cherry commits relative to the reference at point
instead of relative to the current buffer or `HEAD'.
- Instead of adding this symbol, consider pressing \"C-u y o RET\".
+ Instead of adding this symbol, consider pressing \\`C-u y o RET'.
`create-branch'
diff --git a/lisp/magit-stash.el b/lisp/magit-stash.el
index 836b874a6c..45d70c3a4c 100644
--- a/lisp/magit-stash.el
+++ b/lisp/magit-stash.el
@@ -412,7 +412,7 @@ Then apply STASH, dropping it if it applies cleanly."
;;;###autoload
(defun magit-stash-format-patch (stash)
- "Create a patch from STASH"
+ "Create a patch from STASH."
(interactive (list (magit-read-stash "Create patch from stash")))
(with-temp-file (magit-rev-format "0001-%f.patch" stash)
(magit-git-insert "stash" "show" "-p" stash))
diff --git a/lisp/magit.el b/lisp/magit.el
index 90ea55084d..1b3a3767fc 100644
--- a/lisp/magit.el
+++ b/lisp/magit.el
@@ -258,20 +258,20 @@ the current Emacs session.
If the value is nil, no bindings are added.
-If `default', maybe add:
+If \\+`default', maybe add:
- C-x g `magit-status'
- C-x M-g `magit-dispatch'
- C-c M-g `magit-file-dispatch'
+ \\`C-x' \\`g' `magit-status'
+ \\`C-x' \\`M-g' `magit-dispatch'
+ \\`C-c' \\`M-g' `magit-file-dispatch'
If `recommended', maybe add:
- C-x g `magit-status'
- C-c g `magit-dispatch'
- C-c f `magit-file-dispatch'
+ \\`C-x' \\`g' `magit-status'
+ \\`C-c' \\`g' `magit-dispatch'
+ \\`C-c' \\`f' `magit-file-dispatch'
These bindings are strongly recommended, but we cannot use
- them by default, because the \"C-c <LETTER>\" namespace is
+ them by default, because the \\`C-c <LETTER>' namespace is
strictly reserved for bindings added by the user.
The bindings in the chosen set may be added when
@@ -439,7 +439,7 @@ This affects `magit-git-command',
`magit-git-command-topdir',
(defun magit-git-command (command)
"Execute COMMAND asynchronously; display output.
-Interactively, prompt for COMMAND in the minibuffer. \"git \" is
+Interactively, prompt for COMMAND in the minibuffer. \"git \" is
used as initial input, but can be deleted to run another command.
With a prefix argument COMMAND is run in the top-level directory
@@ -451,7 +451,7 @@ of the current working tree, otherwise in
`default-directory'."
(defun magit-git-command-topdir (command)
"Execute COMMAND asynchronously; display output.
-Interactively, prompt for COMMAND in the minibuffer. \"git \" is
+Interactively, prompt for COMMAND in the minibuffer. \"git \" is
used as initial input, but can be deleted to run another command.
COMMAND is run in the top-level directory of the current
