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, 05 Nov 2023 12:27:51 +0000 Message-ID: <87zfzsv0x3.fsf@jeremybryant.net> 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="31159"; mail-complaints-to="usenet@ciao.gmane.io" To: 66949@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sun Nov 05 13:30:39 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 1qzcH0-0007zP-IG for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 05 Nov 2023 13:30:39 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qzcGp-0004BY-JS; Sun, 05 Nov 2023 07:30:27 -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 1qzcGn-00049n-OZ for bug-gnu-emacs@gnu.org; Sun, 05 Nov 2023 07:30:26 -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 1qzcGn-00030u-FX for bug-gnu-emacs@gnu.org; Sun, 05 Nov 2023 07:30:25 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1qzcHN-0007Jc-S8 for bug-gnu-emacs@gnu.org; Sun, 05 Nov 2023 07:31:01 -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, 05 Nov 2023 12:31:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 66949 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Original-Received: via spool by submit@debbugs.gnu.org id=B.169918741020001 (code B ref -1); Sun, 05 Nov 2023 12:31:01 +0000 Original-Received: (at submit) by debbugs.gnu.org; 5 Nov 2023 12:30:10 +0000 Original-Received: from localhost ([127.0.0.1]:36287 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qzcGX-0005B7-DQ for submit@debbugs.gnu.org; Sun, 05 Nov 2023 07:30:09 -0500 Original-Received: from lists.gnu.org ([2001:470:142::17]:42420) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qzcGV-0004hh-3l for submit@debbugs.gnu.org; Sun, 05 Nov 2023 07:30:07 -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 1qzcFp-0003da-33 for bug-gnu-emacs@gnu.org; Sun, 05 Nov 2023 07:29:25 -0500 Original-Received: from out-183.mta0.migadu.com ([91.218.175.183]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qzcFn-0002cw-Ao for bug-gnu-emacs@gnu.org; Sun, 05 Nov 2023 07:29:24 -0500 X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers. DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=jeremybryant.net; s=key1; t=1699187357; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type; bh=vw+B9fQKC+EWK862Y6V8V1N6XMAcJD5yEOSmKVRtRQw=; b=F/T2TucIMj2ruLLNCNABGR6Jb5NZgOJReIh/qgilKHErKvXpfDKMjVEp+4rD3EWjzAQFIP lDVmDG/fuvuBxatJ8vlcGa5hoGowLaR7ZqhmMg15aRlZ4WjkSieoexQcK4xsYHPNkWTEjf rr+JEpCZX5O7wkmWUp8xiYRliLgllSg6YJYbrB3h0VGcJFPcYCcYBHHexY6IZ1OAO5nfMh He2f8vMFKjf82jnhnJqMdwRycY0Bw/MiF4olEhcLRbxBUwMwaPr13013r2b6ro760ixQrP 4ekBER2ubzhhndz1KncSNrrHFENbl2GJLCOKbePmTzbmlrCDM3riFsKDMqlsJA== X-Migadu-Flow: FLOW_OUT Received-SPF: pass client-ip=91.218.175.183; envelope-from=jb@jeremybryant.net; helo=out-183.mta0.migadu.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action 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:273821 Archived-At: --=-=-= Content-Type: text/plain 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 --=-=-= Content-Type: text/patch Content-Disposition: attachment; filename=0001-lisp-emacs-lisp-cl-extra.el-Add-two-docstrings.patch >From 072ff9986dd5693ca468ff217288a587abf59c03 Mon Sep 17 00:00:00 2001 From: Jeremy Bryant 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 --- lisp/emacs-lisp/cl-extra.el | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --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 --=-=-=--