From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: "Drew Adams" Newsgroups: gmane.emacs.bugs Subject: bug#4188: 23.1; doc strings in bookmark.el Date: Wed, 19 Aug 2009 15:23:50 -0700 Message-ID: <93AC19018012425A8D3A6E2163301F3A@us.oracle.com> Reply-To: Drew Adams , 4188@emacsbugs.donarmstrong.com NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Trace: ger.gmane.org 1250798961 30443 80.91.229.12 (20 Aug 2009 20:09:21 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Thu, 20 Aug 2009 20:09:21 +0000 (UTC) To: Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Thu Aug 20 22:09:12 2009 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([199.232.76.165]) by lo.gmane.org with esmtp (Exim 4.50) id 1MeDwc-0002YX-Tn for geb-bug-gnu-emacs@m.gmane.org; Thu, 20 Aug 2009 22:09:11 +0200 Original-Received: from localhost ([127.0.0.1]:48861 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1MeDwc-0008GE-7m for geb-bug-gnu-emacs@m.gmane.org; Thu, 20 Aug 2009 16:09:10 -0400 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1MeDvY-0007oc-Pb for bug-gnu-emacs@gnu.org; Thu, 20 Aug 2009 16:08:04 -0400 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1MeDvT-0007lI-Sm for bug-gnu-emacs@gnu.org; Thu, 20 Aug 2009 16:08:04 -0400 Original-Received: from [199.232.76.173] (port=48436 helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1MeDvT-0007lC-Ox for bug-gnu-emacs@gnu.org; Thu, 20 Aug 2009 16:07:59 -0400 Original-Received: from rzlab.ucr.edu ([138.23.92.77]:43983) by monty-python.gnu.org with esmtps (TLS-1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.60) (envelope-from ) id 1MeDvS-0005uS-VZ for bug-gnu-emacs@gnu.org; Thu, 20 Aug 2009 16:07:59 -0400 Original-Received: from rzlab.ucr.edu (rzlab.ucr.edu [127.0.0.1]) by rzlab.ucr.edu (8.14.3/8.14.3/Debian-5) with ESMTP id n7KK6pZx010334; Thu, 20 Aug 2009 13:07:56 -0700 Original-Received: (from debbugs@localhost) by rzlab.ucr.edu (8.14.3/8.14.3/Submit) id n7KJpGNN006034; Thu, 20 Aug 2009 12:51:16 -0700 Resent-Date: Thu, 20 Aug 2009 12:51:16 -0700 X-Loop: owner@emacsbugs.donarmstrong.com Resent-From: "Drew Adams" Resent-To: bug-submit-list@donarmstrong.com Resent-CC: Emacs Bugs 2Resent-Date: Thu, 20 Aug 2009 19:51:13 +0000 Resent-Message-ID: Resent-Sender: owner@emacsbugs.donarmstrong.com X-Emacs-PR-Message: report 4188 X-Emacs-PR-Package: emacs X-Emacs-PR-Keywords: Original-Received: via spool by submit@emacsbugs.donarmstrong.com id=B.12507206343532 (code B ref -1); Thu, 20 Aug 2009 19:51:13 +0000 Original-Received: (at submit) by emacsbugs.donarmstrong.com; 19 Aug 2009 22:23:54 +0000 X-Spam-Bayes: score:0.5 Bayes not run. spammytokens:Tokens not available. hammytokens:Tokens not available. Original-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 Original-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 Original-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 Original-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 Original-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 Original-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 Original-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 Original-Received: from dradamslap1 (/141.144.160.29) by default (Oracle Beehive Gateway v4.0) with ESMTP ; Wed, 19 Aug 2009 15:23:40 -0700 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) X-detected-operating-system: by monty-python.gnu.org: GNU/Linux 2.6 (newer, 2) Resent-Date: Thu, 20 Aug 2009 16:08:04 -0400 X-BeenThere: bug-gnu-emacs@gnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.bugs:30333 Archived-At: 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)'