From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Lars Magne Ingebrigtsen Newsgroups: gmane.emacs.bugs Subject: bug#957: 23.0.60; No doc string for Dired functions Date: Thu, 07 Jul 2011 18:30:18 +0200 Message-ID: References: <001d01c91360$8a9cf4a0$c2b22382@us.oracle.com> NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: dough.gmane.org 1310062552 2305 80.91.229.12 (7 Jul 2011 18:15:52 GMT) X-Complaints-To: usenet@dough.gmane.org NNTP-Posting-Date: Thu, 7 Jul 2011 18:15:52 +0000 (UTC) Cc: 957@debbugs.gnu.org To: "Drew Adams" Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Thu Jul 07 20:15:47 2011 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([140.186.70.17]) by lo.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1Qet72-0004uH-Nf for geb-bug-gnu-emacs@m.gmane.org; Thu, 07 Jul 2011 20:15:44 +0200 Original-Received: from localhost ([::1]:58802 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Qet71-0007F8-FI for geb-bug-gnu-emacs@m.gmane.org; Thu, 07 Jul 2011 14:15:43 -0400 Original-Received: from eggs.gnu.org ([140.186.70.92]:43595) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1QerUi-0003Q1-I4 for bug-gnu-emacs@gnu.org; Thu, 07 Jul 2011 12:32:06 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1QerUg-0004Dj-Kw for bug-gnu-emacs@gnu.org; Thu, 07 Jul 2011 12:32:04 -0400 Original-Received: from debbugs.gnu.org ([140.186.70.43]:53240) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1QerUg-0004Df-C6 for bug-gnu-emacs@gnu.org; Thu, 07 Jul 2011 12:32:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.69) (envelope-from ) id 1QerUf-0003Qr-PU; Thu, 07 Jul 2011 12:32:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Lars Magne Ingebrigtsen Original-Sender: debbugs-submit-bounces@debbugs.gnu.org Resent-To: owner@debbugs.gnu.org Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Thu, 07 Jul 2011 16:32:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 957 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 957-submit@debbugs.gnu.org id=B957.131005627313131 (code B ref 957); Thu, 07 Jul 2011 16:32:01 +0000 Original-Received: (at 957) by debbugs.gnu.org; 7 Jul 2011 16:31:13 +0000 Original-Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1QerTs-0003Pk-Q1 for submit@debbugs.gnu.org; Thu, 07 Jul 2011 12:31:13 -0400 Original-Received: from hermes.netfonds.no ([80.91.224.195]) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1QerTq-0003PY-Uv for 957@debbugs.gnu.org; Thu, 07 Jul 2011 12:31:11 -0400 Original-Received: from cm-84.215.51.58.getinternet.no ([84.215.51.58] helo=quimbies.gnus.org) by hermes.netfonds.no with esmtpsa (TLS1.0:DHE_RSA_AES_128_CBC_SHA1:16) (Exim 4.72) (envelope-from ) id 1QerTd-0005ad-Ou; Thu, 07 Jul 2011 18:30:57 +0200 In-Reply-To: (Drew Adams's message of "Wed, 6 Jul 2011 12:16:37 -0700") User-Agent: Gnus/5.110018 (No Gnus v0.18) Emacs/24.0.50 (gnu/linux) Face: iVBORw0KGgoAAAANSUhEUgAAADAAAAAwBAMAAAClLOS0AAAAElBMVEVGGAVbJgw1CgCRYTwj AAAqAwB/NdFoAAACZElEQVQ4jV2SzZLbIBCEGxTfQWTvgK278Oze7Q26a4l4/1dJD3bWqVAluzQf PT0/ggte5swDKf5xnEE2WAne/geOwBN8tJwjxJkXAGAIKLDRu5fCAtGLFHk8/5z1CbwnCM9gGKB/ lWLVPIv/e5jKo0cHBcm+AEQ82oykfUzrNzBGVg9XjFdgZgnPojCxPnh6rQ8PebYIP2m9Bs4PMLkQ ZCi8aIdzzMbmyN79zKqHRtaE85UhBeUsju37QEYlJoLGepMQxMzgFUgiOK8fvdMhsgg35+QpQygF fB3grEUVGjm+hOLYpOm9NyqUIHnP4k1JBMENYkQHoTUx4WmCpnjLBEmBNVwcwewQnMi7GWA0yr2V wElBN/ThB2DypSXdjFh6rEHepGhZxSPnL03hsFNxDxPrGUCnQbDaaAk+xzpLCkFnweueX4KBXG8P YAw3wy9lYpwfE07HndN2HCs/Jbbtkta2e9zq74UWccwIfKKZ89I9ljTdOL+0Ym70bLbFxHmDijgV KdOKpWXY3fbclk7ldr8yk5GrVcDVdDtGh867CpxddJNMNUAHu/gZ/STIYy1tobMeBZeabgn5UNLz CLcLNi9H7TcHvdjoM0A/UEGwsQWNt9wemRaCFupWN9hleKgN4VGxddTKn7xUJZEKroWptp4riV5i rvgsrld83n7U7VK3g5S1qkWjN1Pd6D0zSp26Msi/WnFoxKuBAo6pbyogYPyyE2iuoejH1lnmr4si phspnvPoR8T5VL9PH+3phW5wr/UT/glyf1jttml3xp0eBmNOKtgR8b4v7G0bArp2jufYdpf+AOGC v1EP/btvAAAAAElFTkSuQmCC X-Now-Playing: The Smiths's _The World Won't Listen_: "Bigmouth strikes again" X-Hashcash: 1:23:110707:drew.adams@oracle.com::brik5XqL2esBNXIj:00000000000000000000000000000000000000003yrr X-Hashcash: 1:23:110707:957@debbugs.gnu.org::5/BznCUqxtgWSSSG:000000000000000000000000000000000000000000wKfE X-MailScanner-ID: 1QerTd-0005ad-Ou MailScanner-NULL-Check: 1310661057.93674@d9suPfeH9VHIwy4cPGlYwg X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list Resent-Date: Thu, 07 Jul 2011 12:32:01 -0400 X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 3) X-Received-From: 140.186.70.43 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.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.bugs:48181 Archived-At: "Drew Adams" writes: >> but I don't know what `dired-repeat-overlines' is... > > All the more reason for it to get a doc string! I meant that I couldn't find it. :-) But grepping for `dired-repeat-over-lines' found it for me. It, too, is an internal function, and I don't think it's worth documenting all these. They are only useful if you're doing dired development, and then you presumably have the sources and can look at the comments. > Sure they do, in general. Since when do we document only commands? > > In the Dark Ages, doc strings were relatively more expensive (disk, memory, > etc.), and some minor functions were handled with only a comment. Nowadays > there is rarely a good reason not to provide a doc string. I agree, but adding doc strings to purely internal functions that are presumably self-explanatory to people who need to use them to develop isn't all that useful. It's not that I'm against adding doc strings (if somebody feels like doing that), but it's not, in my opinion worth the time. So I'm closing this report. -- (domestic pets only, the antidote for overdose, milk.) bloggy blog http://lars.ingebrigtsen.no/