From unknown Tue Jun 17 20:13:38 2025 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 X-Mailer: MIME-tools 5.509 (Entity 5.509) Content-Type: text/plain; charset=utf-8 From: bug#4188 <4188@debbugs.gnu.org> To: bug#4188 <4188@debbugs.gnu.org> Subject: Status: 23.1; doc strings in bookmark.el Reply-To: bug#4188 <4188@debbugs.gnu.org> Date: Wed, 18 Jun 2025 03:13:38 +0000 retitle 4188 23.1; doc strings in bookmark.el reassign 4188 emacs submitter 4188 "Drew Adams" severity 4188 minor thanks From drew.adams@oracle.com Wed Aug 19 15:23:53 2009 Received: (at submit) by emacsbugs.donarmstrong.com; 19 Aug 2009 22:23:54 +0000 X-Spam-Checker-Version: SpamAssassin 3.2.5-bugs.debian.org_2005_01_02 (2008-06-10) on rzlab.ucr.edu X-Spam-Level: X-Spam-Bayes: score:0.5 Bayes not run. spammytokens:Tokens not available. hammytokens:Tokens not available. X-Spam-Status: No, score=-2.5 required=4.0 tests=AWL,FOURLA autolearn=no version=3.2.5-bugs.debian.org_2005_01_02 Received: from lists.gnu.org (lists.gnu.org [199.232.76.165]) by rzlab.ucr.edu (8.14.3/8.14.3/Debian-5) with ESMTP id n7JMNqHm003529 for ; Wed, 19 Aug 2009 15:23:53 -0700 Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1MdtZP-0005sB-SX for bug-gnu-emacs@gnu.org; Wed, 19 Aug 2009 18:23:51 -0400 Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1MdtZL-0005qE-4n for bug-gnu-emacs@gnu.org; Wed, 19 Aug 2009 18:23:51 -0400 Received: from [199.232.76.173] (port=42254 helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1MdtZK-0005q5-S1 for bug-gnu-emacs@gnu.org; Wed, 19 Aug 2009 18:23:46 -0400 Received: from rcsinet11.oracle.com ([148.87.113.123]:56394 helo=rgminet11.oracle.com) by monty-python.gnu.org with esmtps (TLS-1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.60) (envelope-from ) id 1MdtZK-0007De-HJ for bug-gnu-emacs@gnu.org; Wed, 19 Aug 2009 18:23:46 -0400 Received: from acsinet15.oracle.com (acsinet15.oracle.com [141.146.126.227]) by rgminet11.oracle.com (Switch-3.3.1/Switch-3.3.1) with ESMTP id n7JMNwDb011028 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK) for ; Wed, 19 Aug 2009 22:23:59 GMT Received: from abhmt004.oracle.com (abhmt004.oracle.com [141.146.116.13]) by acsinet15.oracle.com (Switch-3.3.1/Switch-3.3.1) with ESMTP id n7JMOQZj016587 for ; Wed, 19 Aug 2009 22:24:26 GMT Received: from dradamslap1 (/141.144.160.29) by default (Oracle Beehive Gateway v4.0) with ESMTP ; Wed, 19 Aug 2009 15:23:40 -0700 From: "Drew Adams" To: Subject: 23.1; doc strings in bookmark.el Date: Wed, 19 Aug 2009 15:23:50 -0700 Message-ID: <93AC19018012425A8D3A6E2163301F3A@us.oracle.com> MIME-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Mailer: Microsoft Office Outlook 11 Thread-Index: AcohG7njvcs8ZKqjRUCAPo/2AOYL9Q== X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2900.5579 X-Source-IP: abhmt004.oracle.com [141.146.116.13] X-Auth-Type: Internal IP X-CT-RefId: str=0001.0A090207.4A8C7B6D.0136:SCFSTAT5015188,ss=1,fgs=0 X-detected-operating-system: by monty-python.gnu.org: GNU/Linux 2.6 (newer, 1) 1. The function doc strings need to describe the arguments. For example, these functions (at least) should say, "BOOKMARK is a bookmark name or a bookmark record." bookmark-get-bookmark, bookmark-get-bookmark-record, bookmark-prop-get, bookmark-prop-set, bookmark-get-handler, bookmark--jump-via, bookmark-jump-noselect. This is particularly important because some functions expect that their bookmark argument be a bookmark name, others expect that it be a bookmark record, and still others allow either. 2. Some functions (e.g. bookmark--jump-via) are missing doc strings altogether. In GNU Emacs 23.1.1 (i386-mingw-nt5.1.2600) of 2009-07-29 on SOFT-MJASON Windowing system distributor `Microsoft Corp.', version 5.1.2600 configured using `configure --with-gcc (4.4)' From rgm@gnu.org Tue Sep 1 17:19:49 2009 Received: (at control) by emacsbugs.donarmstrong.com; 2 Sep 2009 00:19:50 +0000 X-Spam-Checker-Version: SpamAssassin 3.2.5-bugs.debian.org_2005_01_02 (2008-06-10) on rzlab.ucr.edu X-Spam-Level: X-Spam-Bayes: score:0.5 Bayes not run. spammytokens:Tokens not available. hammytokens:Tokens not available. X-Spam-Status: No, score=-4.7 required=4.0 tests=AWL,ONEWORD,X_DEBBUGS_NO_ACK autolearn=ham version=3.2.5-bugs.debian.org_2005_01_02 Received: from fencepost.gnu.org (fencepost.gnu.org [140.186.70.10]) by rzlab.ucr.edu (8.14.3/8.14.3/Debian-5) with ESMTP id n820JmgD027563 for ; Tue, 1 Sep 2009 17:19:49 -0700 Received: from rgm by fencepost.gnu.org with local (Exim 4.67) (envelope-from ) id 1MidZj-00057T-Pj; Tue, 01 Sep 2009 20:19:47 -0400 MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: 7bit Message-ID: <19101.47651.751304.471008@fencepost.gnu.org> Date: Tue, 1 Sep 2009 20:19:47 -0400 From: Glenn Morris To: control Subject: control X-Attribution: GM X-Mailer: VM (www.wonderworks.com/vm), GNU Emacs (www.gnu.org/software/emacs) X-Hue: red X-Ran: 3H"a9#$t4]il; Sun, 4 Oct 2009 18:36:33 -0700 Received: from localhost ([127.0.0.1]:36736 helo=floss ident=kfogel) by sanpietro.red-bean.com with esmtp (Exim 4.69) (envelope-from ) id 1MucV6-0002Py-2a for 4188-close@emacsbugs.donarmstrong.com; Sun, 04 Oct 2009 20:36:32 -0500 From: Karl Fogel To: 4188-close@debbugs.gnu.org Subject: Fixed "doc strings in bookmark.el" Reply-To: Karl Fogel Date: Sun, 04 Oct 2009 21:36:31 -0400 Message-ID: <87y6nqmxk0.fsf@red-bean.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii fixed -- Thanks for the report. Fix committed: $ cvs ci -F msg lisp/bookmark.el lisp/ChangeLog /sources/emacs/emacs/lisp/bookmark.el,v <-- lisp/bookmark.el new revision: 1.128; previous revision: 1.127 /sources/emacs/emacs/lisp/ChangeLog,v <-- lisp/ChangeLog new revision: 1.16354; previous revision: 1.16353 Mailing notification to emacs-diffs@gnu.org... sent. $ From drew.adams@oracle.com Sat Oct 10 11:19:42 2009 Received: (at submit) by emacsbugs.donarmstrong.com; 10 Oct 2009 18:19:42 +0000 X-Spam-Checker-Version: SpamAssassin 3.2.5-bugs.debian.org_2005_01_02 (2008-06-10) on rzlab.ucr.edu X-Spam-Level: X-Spam-Bayes: score:0.5 Bayes not run. spammytokens:Tokens not available. hammytokens:Tokens not available. X-Spam-Status: No, score=-3.9 required=4.0 tests=AWL,HAS_BUG_NUMBER autolearn=ham version=3.2.5-bugs.debian.org_2005_01_02 Received: from lists.gnu.org (lists.gnu.org [199.232.76.165]) by rzlab.ucr.edu (8.14.3/8.14.3/Debian-5) with ESMTP id n9AIJe3j003341 for ; Sat, 10 Oct 2009 11:19:42 -0700 Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1MwgXc-0003GB-EF for bug-gnu-emacs@gnu.org; Sat, 10 Oct 2009 14:19:40 -0400 Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1MwgXX-0003Bw-TQ for bug-gnu-emacs@gnu.org; Sat, 10 Oct 2009 14:19:39 -0400 Received: from [199.232.76.173] (port=45177 helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1MwgXX-0003Bt-Md for bug-gnu-emacs@gnu.org; Sat, 10 Oct 2009 14:19:35 -0400 Received: from rcsinet12.oracle.com ([148.87.113.124]:52192 helo=rgminet12.oracle.com) by monty-python.gnu.org with esmtps (TLS-1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.60) (envelope-from ) id 1MwgXX-0004sj-8R for bug-gnu-emacs@gnu.org; Sat, 10 Oct 2009 14:19:35 -0400 Received: from acsinet15.oracle.com (acsinet15.oracle.com [141.146.126.227]) by rgminet12.oracle.com (Switch-3.3.1/Switch-3.3.1) with ESMTP id n9AIJBIB006674 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK); Sat, 10 Oct 2009 18:19:12 GMT Received: from acsmt355.oracle.com (acsmt355.oracle.com [141.146.40.155]) by acsinet15.oracle.com (Switch-3.3.1/Switch-3.3.1) with ESMTP id n9AHkIL8016567; Sat, 10 Oct 2009 18:20:24 GMT Received: from abhmt015.oracle.com by acsmt358.oracle.com with ESMTP id 20332062151255198734; Sat, 10 Oct 2009 13:18:54 -0500 Received: from dradamslap1 (/24.5.184.158) by default (Oracle Beehive Gateway v4.0) with ESMTP ; Sat, 10 Oct 2009 11:18:54 -0700 From: "Drew Adams" To: "'Karl Fogel'" , References: <87y6nqmxk0.fsf@red-bean.com><93AC19018012425A8D3A6E2163301F3A@us.oracle.com> Subject: RE: bug#4188: marked as done (23.1; doc strings in bookmark.el) Date: Sat, 10 Oct 2009 11:17:55 -0700 Message-ID: MIME-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Mailer: Microsoft Office Outlook 11 Thread-Index: AcpFXd51RvyrScilQzCVwXe9elUGNQEd46dQ In-Reply-To: X-MIMEOLE: Produced By Microsoft MimeOLE V6.00.2900.5579 X-Source-IP: acsmt355.oracle.com [141.146.40.155] X-Auth-Type: Internal IP X-CT-RefId: str=0001.0A090205.4AD0D032.00A2:SCFMA4539814,ss=1,fgs=0 X-detected-operating-system: by monty-python.gnu.org: GNU/Linux 2.6 (newer, 1) >> 2. Some functions (e.g. bookmark--jump-via) are missing doc strings >> altogether. There are still some things that need doc strings. `bookmark-current-buffer', for instance. The doc strings of other functions (e.g. `bookmark-yank-word' need to refer to this buffer, but they cannot refer to it by name, since `buffer-current-buffer' has no doc string. From kfogel@red-bean.com Sat Oct 10 14:55:09 2009 Received: (at submit) by emacsbugs.donarmstrong.com; 10 Oct 2009 21:55:09 +0000 X-Spam-Checker-Version: SpamAssassin 3.2.5-bugs.debian.org_2005_01_02 (2008-06-10) on rzlab.ucr.edu X-Spam-Level: X-Spam-Bayes: score:0.5 Bayes not run. spammytokens:Tokens not available. hammytokens:Tokens not available. X-Spam-Status: No, score=-1.4 required=4.0 tests=AWL,HAS_BUG_NUMBER autolearn=ham version=3.2.5-bugs.debian.org_2005_01_02 Received: from lists.gnu.org (lists.gnu.org [199.232.76.165]) by rzlab.ucr.edu (8.14.3/8.14.3/Debian-5) with ESMTP id n9ALt7Nb002192 for ; Sat, 10 Oct 2009 14:55:09 -0700 Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1Mwju7-0003n0-Ef for bug-gnu-emacs@gnu.org; Sat, 10 Oct 2009 17:55:07 -0400 Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1Mwju2-0003eD-WF for bug-gnu-emacs@gnu.org; Sat, 10 Oct 2009 17:55:07 -0400 Received: from [199.232.76.173] (port=54745 helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1Mwju2-0003e6-P1 for bug-gnu-emacs@gnu.org; Sat, 10 Oct 2009 17:55:02 -0400 Received: from sanpietro.red-bean.com ([66.146.206.141]:48396) by monty-python.gnu.org with esmtps (TLS-1.0:RSA_AES_256_CBC_SHA1:32) (Exim 4.60) (envelope-from ) id 1Mwju2-0002D8-DZ for bug-gnu-emacs@gnu.org; Sat, 10 Oct 2009 17:55:02 -0400 Received: from localhost ([127.0.0.1]:45419 helo=floss ident=kfogel) by sanpietro.red-bean.com with esmtp (Exim 4.69) (envelope-from ) id 1Mwju1-0006d6-KZ; Sat, 10 Oct 2009 16:55:01 -0500 From: Karl Fogel To: "Drew Adams" Cc: Subject: Re: bug#4188: marked as done (23.1; doc strings in bookmark.el) References: <87y6nqmxk0.fsf@red-bean.com> <93AC19018012425A8D3A6E2163301F3A@us.oracle.com> Reply-To: Karl Fogel Date: Sat, 10 Oct 2009 17:55:01 -0400 In-Reply-To: (Drew Adams's message of "Sat, 10 Oct 2009 11:17:55 -0700") Message-ID: <87aazy7w3u.fsf@red-bean.com> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/23.1.50 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-detected-operating-system: by monty-python.gnu.org: GNU/Linux 2.6 (newer, 3) "Drew Adams" writes: >>> 2. Some functions (e.g. bookmark--jump-via) are missing doc strings >>> altogether. > > There are still some things that need doc strings. > > `bookmark-current-buffer', for instance. The doc strings of other > functions (e.g. `bookmark-yank-word' need to refer to this buffer, but > they cannot refer to it by name, since `buffer-current-buffer' has no > doc string. Oops, sorry, missed the variables. Fixed in these two revs: $ cvs ci -F msg lisp/bookmark.el lisp/ChangeLog /sources/emacs/emacs/lisp/bookmark.el,v <-- lisp/bookmark.el new revision: 1.135; previous revision: 1.134 /sources/emacs/emacs/lisp/ChangeLog,v <-- lisp/ChangeLog new revision: 1.16400; previous revision: 1.16399 Mailing notification to emacs-diffs@gnu.org... sent. $ cvs ci -F msg lisp/bookmark.el lisp/ChangeLog /sources/emacs/emacs/lisp/bookmark.el,v <-- lisp/bookmark.el new revision: 1.136; previous revision: 1.135 /sources/emacs/emacs/lisp/ChangeLog,v <-- lisp/ChangeLog new revision: 1.16401; previous revision: 1.16400 Mailing notification to emacs-diffs@gnu.org... sent. $ From unknown Tue Jun 17 20:13:38 2025 Received: (at fakecontrol) by fakecontrolmessage; To: internal_control@debbugs.gnu.org From: Debbugs Internal Request Subject: Internal Control Message-Id: bug archived. Date: Sun, 08 Nov 2009 15:24:36 +0000 User-Agent: Fakemail v42.6.9 # A New Hope # A long time ago, in a galaxy far, far away # something happened. # # Magically this resulted in the following # action being taken, but this fake control # message doesn't tell you why it happened # # The action: # bug archived. thanks # This fakemail brought to you by your local debbugs # administrator