From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Jeremy Bryant via "Bug reports for GNU Emacs, the Swiss army knife of text editors" Newsgroups: gmane.emacs.bugs Subject: bug#66949: [PATCH] * lisp/emacs-lisp/cl-extra.el: Add two docstrings Date: Sun, 12 Nov 2023 15:12:15 +0000 Message-ID: <875y27dmv7.fsf@jeremybryant.net> References: <87zfzsv0x3.fsf@jeremybryant.net> <83msvkwq17.fsf@gnu.org> Reply-To: Jeremy Bryant Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="19553"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 66949@debbugs.gnu.org To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sun Nov 12 16:16:46 2023 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1r2CCc-0004sT-MK for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 12 Nov 2023 16:16:46 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1r2CCF-0003bv-8z; Sun, 12 Nov 2023 10:16:23 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1r2CCD-0003bj-PV for bug-gnu-emacs@gnu.org; Sun, 12 Nov 2023 10:16:21 -0500 Original-Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1r2CCD-0002ow-Hx for bug-gnu-emacs@gnu.org; Sun, 12 Nov 2023 10:16:21 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1r2CCs-0000FH-4G for bug-gnu-emacs@gnu.org; Sun, 12 Nov 2023 10:17:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Jeremy Bryant Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 12 Nov 2023 15:17:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 66949 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 66949-submit@debbugs.gnu.org id=B66949.1699802163839 (code B ref 66949); Sun, 12 Nov 2023 15:17:02 +0000 Original-Received: (at 66949) by debbugs.gnu.org; 12 Nov 2023 15:16:03 +0000 Original-Received: from localhost ([127.0.0.1]:56772 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1r2CBr-0000D9-Ho for submit@debbugs.gnu.org; Sun, 12 Nov 2023 10:16:03 -0500 Original-Received: from out-177.mta0.migadu.com ([91.218.175.177]:10415) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1r2CBm-0000Ct-MK for 66949@debbugs.gnu.org; Sun, 12 Nov 2023 10:15:58 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=jeremybryant.net; s=key1; t=1699802112; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=dDfTObSAfRqrXQX8jzF4KZoKublsxYEkTmlW2bchQlQ=; b=XQP667ogNlxB11tKD+WdJxyj1gDILev5P8wWW+985nZo7/NFrc6yytM/d9wGitMUMjplJK v107S5KMzSPTSrW0il3efYfpJt7PHhzmQce1jiULtpoZ4bH2EYaT+wblif5cNYl8BVwQ6c bwp9rFhakJfLxeEcZSQiebcYEcjyhNGwu17x4M30GZiRrxwxBWQo0sU9DafREHgTnJlPCC o6IhZ+clfvVkUmZqFLxbG4ORD21//oJChcMNBqQQ4dB+aZmiwjnF1Tsp9KBU3C3RW8NwSU 1Oz+D6dQpGLKGewa97Lk7jcciU9/CpRwCG/342d4s6uvk0OskibNx//wZ2YfLA== X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers. In-reply-to: <83msvkwq17.fsf@gnu.org> X-Migadu-Flow: FLOW_OUT X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:274207 Archived-At: --=-=-= Content-Type: text/x-diff Content-Disposition: attachment; filename=0001-lisp-emacs-lisp-cl-extra.el-Add-two-docstrings.patch >From 5ebc59aa54bf762eb54d76cccf07c8a3b222467b Mon Sep 17 00:00:00 2001 From: Jeremy Bryant 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 --- lisp/emacs-lisp/cl-extra.el | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --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 --=-=-= Content-Type: text/plain 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 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" >> >> 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? --=-=-=--