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#66828: [PATCH] Add docstrings in cl-lib.el Date: Sun, 29 Oct 2023 22:07:13 +0000 Message-ID: <87fs1txerp.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="17408"; mail-complaints-to="usenet@ciao.gmane.io" To: 66828@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sun Oct 29 23:09:56 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 1qxDym-0004IP-Dg for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 29 Oct 2023 23:09:56 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qxDyO-0005ai-Vu; Sun, 29 Oct 2023 18:09:33 -0400 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 1qxDyM-0005aB-Vt for bug-gnu-emacs@gnu.org; Sun, 29 Oct 2023 18:09:31 -0400 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 1qxDyK-000086-U9 for bug-gnu-emacs@gnu.org; Sun, 29 Oct 2023 18:09:30 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1qxDyr-0005Mx-Lz for bug-gnu-emacs@gnu.org; Sun, 29 Oct 2023 18:10:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Jeremy Bryant Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 29 Oct 2023 22:10:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 66828 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.169861739320616 (code B ref -1); Sun, 29 Oct 2023 22:10:01 +0000 Original-Received: (at submit) by debbugs.gnu.org; 29 Oct 2023 22:09:53 +0000 Original-Received: from localhost ([127.0.0.1]:43695 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qxDyi-0005MQ-OD for submit@debbugs.gnu.org; Sun, 29 Oct 2023 18:09:53 -0400 Original-Received: from lists.gnu.org ([2001:470:142::17]:49636) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qxDyf-0005MA-C0 for submit@debbugs.gnu.org; Sun, 29 Oct 2023 18:09:51 -0400 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 1qxDxy-0005WA-Tj for bug-gnu-emacs@gnu.org; Sun, 29 Oct 2023 18:09:08 -0400 Original-Received: from out-183.mta1.migadu.com ([95.215.58.183]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qxDxv-0008Ra-PD for bug-gnu-emacs@gnu.org; Sun, 29 Oct 2023 18:09:06 -0400 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=1698617340; 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=ua0d1lvxtZoiipV5rt8qG8041FYzr1T4/LjB1y9Rvdw=; b=d0fNQwr6dR5JLnuBIW48hOkoPhbYztnnJHTYCr3c5CL45ufjQfwhHazCwd2CcCpiDd203A gnf3Djd+oU8OzUm4jqQcW+oZxEoQoyJsdjSQgA6VS0IES4aFGxttnrFfHQlKvb5oAcp0eg vAdwRZtiyNl+Ae3sqHdSlk6G5s3Ht2WfVu8M1brTs/fc7EsugnLL9Aec9DYNFD3wVG1Jk2 PYoW5VTgDtlRBHedGqVPAF4pIN6TEjxObr5GYe840dZcGVXK+haHLTFkTDxc9TqiNGCV63 JO25k1+Ec8+LkMydlI3b1uJmcIDQ07BJ0H+DkKFiBTdDYqC+gTHWX08xU3EEsg== X-Migadu-Flow: FLOW_OUT Received-SPF: pass client-ip=95.215.58.183; envelope-from=jb@jeremybryant.net; helo=out-183.mta1.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 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:273532 Archived-At: --=-=-= Content-Type: text/plain Tags: patch Hello Emacs maintainers, Following recent discussions on documentation in cl-lib, I would like to submit a simple patch, creating docstrings where there were none previously. Feedback welcome on format, conventions and any other aspects. Best, Jeremy --=-=-= Content-Type: text/patch Content-Disposition: attachment; filename=0001-Add-docstrings-in-cl-lib.el.patch >From 02e487816f5542d30b8cdf0e3f748926f9b7cf2e Mon Sep 17 00:00:00 2001 From: Jeremy Bryant Date: Sun, 29 Oct 2023 21:56:54 +0000 Subject: [PATCH] Add docstrings in cl-lib.el * lisp/emacs-lisp/cl-lib.el (cl--set-buffer-substring): Add docstring (cl--defalias): Add docstring --- lisp/emacs-lisp/cl-lib.el | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/lisp/emacs-lisp/cl-lib.el b/lisp/emacs-lisp/cl-lib.el index f4c1ac85b13..29b6c2f3545 100644 --- a/lisp/emacs-lisp/cl-lib.el +++ b/lisp/emacs-lisp/cl-lib.el @@ -157,6 +157,7 @@ cl-pushnew `(cl-callf2 cl-adjoin ,x ,place ,@keys))) (defun cl--set-buffer-substring (start end val) + "Delete region from START to END and insert VAL." (save-excursion (delete-region start end) (goto-char start) (insert val) @@ -194,6 +195,9 @@ 'cl--block-throw ;; the target form to return the values as a list. (defun cl--defalias (cl-f el-f &optional doc) + "Define function CL-F as definition EL-F. + +For example, (cl--defalias 'cl-first 'car)." (defalias cl-f el-f doc) (put cl-f 'byte-optimizer 'byte-compile-inline-expand)) -- 2.40.1 --=-=-=--