aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJonas Bernoulli <jonas@bernoul.li>2026-03-24 23:23:11 +0100
committerJonas Bernoulli <jonas@bernoul.li>2026-03-24 23:23:11 +0100
commit2e1ed3b0953adc77add432af8f46600c4e1abafd (patch)
treeb09db06077122ad4ea55c24899ca5c3a7703bc9f
parent8f693b78899c486c45a96bd218e1b40204e397ed (diff)
magit-commit-p: Future-proof docstring
-rw-r--r--lisp/magit-git.el5
1 files changed, 3 insertions, 2 deletions
diff --git a/lisp/magit-git.el b/lisp/magit-git.el
index 2bb6c0e..ee52c2a 100644
--- a/lisp/magit-git.el
+++ b/lisp/magit-git.el
@@ -1451,9 +1451,10 @@ string \"true\", otherwise return nil."
(magit-git-string "rev-parse" "--verify" rev))
(defun magit-commit-p (rev)
- "Return commit oid for REV if it can be dereferences as a commit.
+ "Return non-nil if REV can be dereferences as a commit.
Otherwise return nil. Use `magit-commit-oid' if you actually need
-the oid; eventually this function will return t instead of the oid."
+the oid; eventually this function will return t instead of the oid,
+as it curently does for backward compatibility."
;; TODO Return t instead of the oid.
(magit-rev-verify (magit--rev-dereference rev)))