From: Jeremy Bryant via "Bug reports for GNU Emacs, the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
To: 66949@debbugs.gnu.org
Subject: bug#66949: [PATCH] * lisp/emacs-lisp/cl-extra.el: Add two docstrings
Date: Sun, 05 Nov 2023 12:27:51 +0000 [thread overview]
Message-ID: <87zfzsv0x3.fsf@jeremybryant.net> (raw)
[-- Attachment #1: Type: text/plain, Size: 245 bytes --]
Tags: patch
Hi,
Here is a proposed patch to add two docstrings where there were none. I
believe this fits the conventions, otherwise please let me know what is
needed. The patch is attached for install for your consideration.
Best,
Jeremy
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-lisp-emacs-lisp-cl-extra.el-Add-two-docstrings.patch --]
[-- Type: text/patch, Size: 1174 bytes --]
From 072ff9986dd5693ca468ff217288a587abf59c03 Mon Sep 17 00:00:00 2001
From: Jeremy Bryant <jb@jeremybryant.net>
Date: Sun, 5 Nov 2023 12:24:48 +0000
Subject: [PATCH] * lisp/emacs-lisp/cl-extra.el: Add two docstrings
(cl--random-time)
(cl-find-class): Add docstrings
---
| 9 ++++++++-
1 file changed, 8 insertions(+), 1 deletion(-)
--git a/lisp/emacs-lisp/cl-extra.el b/lisp/emacs-lisp/cl-extra.el
index 8c35c344d7d..454076eb3f0 100644
--- a/lisp/emacs-lisp/cl-extra.el
+++ b/lisp/emacs-lisp/cl-extra.el
@@ -440,7 +440,11 @@ cl-parse-integer
;; Random numbers.
-(defun cl--random-time () (car (time-convert nil t)))
+(defun cl--random-time ()
+ "Return high-precision timestamp from `time-convert'.
+
+For example, suitable for use as seed by `cl-make-random-state'."
+ (car (time-convert nil t)))
;;;###autoload (autoload 'cl-random-state-p "cl-extra")
(cl-defstruct (cl--random-state
@@ -734,6 +738,9 @@ 'cl-type-definition
;;;###autoload
(defun cl-find-class (type)
+ "Return CL class of TYPE.
+
+Call `cl--find-class' to get TYPE's propname `cl--class'"
(cl--find-class type))
;;;###autoload
--
2.40.1
next reply other threads:[~2023-11-05 12:27 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-11-05 12:27 Jeremy Bryant via Bug reports for GNU Emacs, the Swiss army knife of text editors [this message]
2023-11-11 10:19 ` bug#66949: [PATCH] * lisp/emacs-lisp/cl-extra.el: Add two docstrings Eli Zaretskii
2023-11-12 15:12 ` Jeremy Bryant via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-11-12 19:16 ` Eli Zaretskii
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87zfzsv0x3.fsf@jeremybryant.net \
--to=bug-gnu-emacs@gnu.org \
--cc=66949@debbugs.gnu.org \
--cc=jb@jeremybryant.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).