From: Jeremy Bryant via "Bug reports for GNU Emacs, the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
To: Eli Zaretskii <eliz@gnu.org>
Cc: 66949@debbugs.gnu.org
Subject: bug#66949: [PATCH] * lisp/emacs-lisp/cl-extra.el: Add two docstrings
Date: Sun, 12 Nov 2023 15:12:15 +0000 [thread overview]
Message-ID: <875y27dmv7.fsf@jeremybryant.net> (raw)
In-Reply-To: <83msvkwq17.fsf@gnu.org>
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: 0001-lisp-emacs-lisp-cl-extra.el-Add-two-docstrings.patch --]
[-- Type: text/x-diff, Size: 1303 bytes --]
From 5ebc59aa54bf762eb54d76cccf07c8a3b222467b Mon Sep 17 00:00:00 2001
From: Jeremy Bryant <jb@jeremybryant.net>
Date: Sun, 12 Nov 2023 15:07:23 +0000
Subject: [PATCH] * lisp/emacs-lisp/cl-extra.el: Add two docstrings
(cl--random-time)
(cl-find-class): Add docstrings
---
| 11 +++++++++--
1 file changed, 9 insertions(+), 2 deletions(-)
--git a/lisp/emacs-lisp/cl-extra.el b/lisp/emacs-lisp/cl-extra.el
index de5eb9c2d92..8ba320cdfb6 100644
--- a/lisp/emacs-lisp/cl-extra.el
+++ b/lisp/emacs-lisp/cl-extra.el
@@ -440,7 +440,10 @@ cl-parse-integer
;; Random numbers.
(defun cl--random-time ()
- (car (time-convert nil t)))
+ "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
@@ -733,7 +736,11 @@ 'cl-type-definition
(declare-function help-fns-short-filename "help-fns" (filename))
;;;###autoload
-(defun cl-find-class (type) (cl--find-class type))
+(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
(defun cl-describe-type (type)
--
2.40.1
[-- Attachment #2: Type: text/plain, Size: 780 bytes --]
OK, I now understand that documentation patches ought to be based on the
last release. Please find attached the same patch as a diff to
emacs-29. Please confirm if this is suitable to install in this form.
Eli Zaretskii <eliz@gnu.org> writes:
>> Date: Sun, 05 Nov 2023 12:27:51 +0000
>> From: Jeremy Bryant via "Bug reports for GNU Emacs,
>> the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
>>
>> 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.
>
> Thanks, but it doesn't apply to the current Emacs Git. Would you like
> to rebase it onto the current emacs-29 branch, and then resubmit?
next prev parent reply other threads:[~2023-11-12 15:12 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-11-05 12:27 bug#66949: [PATCH] * lisp/emacs-lisp/cl-extra.el: Add two docstrings Jeremy Bryant via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-11-11 10:19 ` Eli Zaretskii
2023-11-12 15:12 ` Jeremy Bryant via Bug reports for GNU Emacs, the Swiss army knife of text editors [this message]
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=875y27dmv7.fsf@jeremybryant.net \
--to=bug-gnu-emacs@gnu.org \
--cc=66949@debbugs.gnu.org \
--cc=eliz@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).