branch: externals/compat
commit b69d8c192032c0570d017ffaf9bd0a94663334d3
Author: Daniel Mendler <m...@daniel-mendler.de>
Commit: Daniel Mendler <m...@daniel-mendler.de>
Shorten docstrings of :explicit definitions
---
compat-25.el | 2 +-
compat-27.el | 19 +++----------------
compat-28.el | 16 ++++------------
3 files changed, 8 insertions(+), 29 deletions(-)
diff --git a/compat-25.el b/compat-25.el
index 8f216e8b16..4fa47b6898 100644
--- a/compat-25.el
+++ b/compat-25.el
@@ -42,7 +42,7 @@ usage: (bool-vector &rest OBJECTS)"
;;;; Defined in fns.c
(compat-defun sort (seq predicate) ;; <compat-tests:sort>
- "Extend `sort' to sort SEQ as a vector."
+ "Handle vector SEQ."
:explicit t
(cond
((listp seq)
diff --git a/compat-27.el b/compat-27.el
index de551642b0..6c88f424ab 100644
--- a/compat-27.el
+++ b/compat-27.el
@@ -304,8 +304,7 @@ the minibuffer was activated, and execute the forms."
;;;; Defined in image.el
(compat-defun image--set-property (image property value) ;;
<compat-tests:image-property>
- "Set PROPERTY in IMAGE to VALUE.
-Internal use only."
+ "Set PROPERTY in IMAGE to VALUE, internal use only."
:explicit "26.1"
:feature image
(if (null value)
@@ -342,16 +341,7 @@ Internal use only."
(concat (file-remote-p name) "/:" (file-local-name name)))))
(compat-defun file-size-human-readable (file-size &optional flavor space unit)
;; <compat-tests:file-size-human-readable>
- "Handle the optional arguments SPACE and UNIT.
-
-Optional third argument SPACE is a string put between the number and unit.
-It defaults to the empty string. We recommend a single space or
-non-breaking space, unless other constraints prohibit a space in that
-position.
-
-Optional fourth argument UNIT is the unit to use. It defaults to \"B\"
-when FLAVOR is `iec' and the empty string otherwise. We recommend \"B\"
-in all cases, since that is the standard symbol for byte."
+ "Handle the optional arguments SPACE and UNIT."
:explicit t
(let ((power (if (or (null flavor) (eq flavor 'iec))
1024.0
@@ -394,10 +384,7 @@ the value of the variable `exec-path'."
exec-path))))
(compat-defun executable-find (command &optional remote) ;;
<compat-tests:executable-find>
- "Search for COMMAND in `exec-path' and return the absolute file name.
-Return nil if COMMAND is not found anywhere in `exec-path'. If
-REMOTE is non-nil, search on the remote host indicated by
-`default-directory' instead."
+ "Handle optional argument REMOTE."
:explicit t
(if (and remote (file-remote-p default-directory))
(let ((res (locate-file
diff --git a/compat-28.el b/compat-28.el
index e1527e7d92..13685fdc7b 100644
--- a/compat-28.el
+++ b/compat-28.el
@@ -111,9 +111,7 @@ inserted before contatenating."
;;;; Defined in characters.c
(compat-defun string-width (string &optional from to) ;;
<compat-tests:string-width>
- "Handle optional arguments FROM and TO.
-Optional arguments FROM and TO specify the substring of STRING to
-consider, and are interpreted as in `substring'."
+ "Handle optional arguments FROM and TO."
:explicit t
(let* ((len (length string))
(from (or from 0))
@@ -125,9 +123,7 @@ consider, and are interpreted as in `substring'."
;;;; Defined in dired.c
(compat-defun directory-files (directory &optional full match nosort count) ;;
<compat-tests:directory-files>
- "Handle additional optional argument COUNT.
-If COUNT is non-nil and a natural number, the function will
- return COUNT number of file names (if so many are present)."
+ "Handle additional optional argument COUNT."
:explicit t
(let ((files (directory-files directory full match nosort)))
(when (natnump count)
@@ -135,9 +131,7 @@ If COUNT is non-nil and a natural number, the function will
files))
(compat-defun directory-files-and-attributes (directory &optional full match
nosort id-format count) ;; <compat-tests:directory-files-and-attributs>
- "Handle additional optional argument COUNT.
-If COUNT is non-nil and a natural number, the function will
- return COUNT number of file names (if so many are present)."
+ "Handle additional optional argument COUNT."
:explicit t
(let ((files (directory-files-and-attributes directory full match nosort
id-format)))
(when (natnump count)
@@ -691,9 +685,7 @@ the last form in BODY."
(set-window-dedicated-p ,window-sym ,window-dedicated-sym)))))
(compat-defun count-windows (&optional minibuf all-frames) ;;
<compat-tests:count-windows>
- "Handle optional argument ALL-FRAMES.
-If ALL-FRAMES is non-nil, count the windows in all frames instead
-just the selected frame."
+ "Handle optional argument ALL-FRAMES."
:explicit t
(if all-frames
(let ((sum 0))
