* bug#66949: [PATCH] * lisp/emacs-lisp/cl-extra.el: Add two docstrings
@ 2023-11-05 12:27 Jeremy Bryant via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-11-11 10:19 ` Eli Zaretskii
0 siblings, 1 reply; 4+ messages in thread
From: Jeremy Bryant via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2023-11-05 12:27 UTC (permalink / raw)
To: 66949
[-- 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
^ permalink raw reply related [flat|nested] 4+ messages in thread
* bug#66949: [PATCH] * lisp/emacs-lisp/cl-extra.el: Add two docstrings
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
0 siblings, 1 reply; 4+ messages in thread
From: Eli Zaretskii @ 2023-11-11 10:19 UTC (permalink / raw)
To: Jeremy Bryant; +Cc: 66949
> 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?
^ permalink raw reply [flat|nested] 4+ messages in thread
* bug#66949: [PATCH] * lisp/emacs-lisp/cl-extra.el: Add two docstrings
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
2023-11-12 19:16 ` Eli Zaretskii
0 siblings, 1 reply; 4+ messages in thread
From: Jeremy Bryant via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2023-11-12 15:12 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: 66949
[-- 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?
^ permalink raw reply related [flat|nested] 4+ messages in thread
end of thread, other threads:[~2023-11-12 19:16 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
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
2023-11-12 19:16 ` Eli Zaretskii
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.