From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#29328: 24.5; doc string of `transpose-subr` Date: Fri, 17 Nov 2017 17:45:30 +0200 Message-ID: <83o9o0hpt1.fsf@gnu.org> References: <2b3492ed-c7ab-433b-a8ff-3de3c5f38c62@default> <83shddggqe.fsf@gnu.org> <93f79e75-eac2-406c-b483-5bf60020a7e4@default> Reply-To: Eli Zaretskii NNTP-Posting-Host: blaine.gmane.org X-Trace: blaine.gmane.org 1510933635 2533 195.159.176.226 (17 Nov 2017 15:47:15 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Fri, 17 Nov 2017 15:47:15 +0000 (UTC) Cc: 29328-done@debbugs.gnu.org To: Drew Adams Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Fri Nov 17 16:47:11 2017 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by blaine.gmane.org with esmtp (Exim 4.84_2) (envelope-from ) id 1eFirC-0000C6-Vw for geb-bug-gnu-emacs@m.gmane.org; Fri, 17 Nov 2017 16:47:07 +0100 Original-Received: from localhost ([::1]:46526 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1eFirJ-0001yK-Vm for geb-bug-gnu-emacs@m.gmane.org; Fri, 17 Nov 2017 10:47:14 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:46104) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1eFirC-0001vw-Qe for bug-gnu-emacs@gnu.org; Fri, 17 Nov 2017 10:47:07 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1eFir8-0006aj-GL for bug-gnu-emacs@gnu.org; Fri, 17 Nov 2017 10:47:06 -0500 Original-Received: from debbugs.gnu.org ([208.118.235.43]:36499) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1eFir8-0006aM-DO for bug-gnu-emacs@gnu.org; Fri, 17 Nov 2017 10:47:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1eFir8-0002Eb-6S for bug-gnu-emacs@gnu.org; Fri, 17 Nov 2017 10:47:02 -0500 Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-To: bug-gnu-emacs@gnu.org Resent-Date: Fri, 17 Nov 2017 15:47:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: cc-closed 29328 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Mail-Followup-To: 29328@debbugs.gnu.org, eliz@gnu.org, drew.adams@oracle.com Original-Received: via spool by 29328-done@debbugs.gnu.org id=D29328.15109335628513 (code D ref 29328); Fri, 17 Nov 2017 15:47:01 +0000 Original-Received: (at 29328-done) by debbugs.gnu.org; 17 Nov 2017 15:46:02 +0000 Original-Received: from localhost ([127.0.0.1]:45179 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1eFiqA-0002D5-Dl for submit@debbugs.gnu.org; Fri, 17 Nov 2017 10:46:02 -0500 Original-Received: from eggs.gnu.org ([208.118.235.92]:54543) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1eFiq8-0002CX-89 for 29328-done@debbugs.gnu.org; Fri, 17 Nov 2017 10:46:00 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1eFipy-0004N0-Hg for 29328-done@debbugs.gnu.org; Fri, 17 Nov 2017 10:45:55 -0500 Original-Received: from fencepost.gnu.org ([2001:4830:134:3::e]:60577) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1eFipy-0004Mr-Dz; Fri, 17 Nov 2017 10:45:50 -0500 Original-Received: from [176.228.60.248] (port=2979 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1eFipx-0001B8-A3; Fri, 17 Nov 2017 10:45:50 -0500 In-reply-to: <93f79e75-eac2-406c-b483-5bf60020a7e4@default> (message from Drew Adams on Fri, 17 Nov 2017 07:02:22 -0800 (PST)) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 208.118.235.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" Xref: news.gmane.org gmane.emacs.bugs:140012 Archived-At: > Date: Fri, 17 Nov 2017 07:02:22 -0800 (PST) > From: Drew Adams > Cc: 29328@debbugs.gnu.org > > > > The doc string should describe each parameter. Parameter SPECIAL is > > > not described, and its name is not specific or enlightening. > > > > I don't see how it can be meaningfully documented. > > That's tantamount to saying that the parameter has no meaning, > no behavior. No, it isn't. It's tantamount to saying what I have just said. > If it does something then that something should > be describable, in some way, at least. The place to start is > with the intention - why do we have such a parameter? What > does it let you do? Why/when would code ever make use of it? Thanks for the lecture. Rest assured, I asked myself all of those questions, and then some. This is an internal subroutine, so it doesn't have to document everything. Please accept my judgment on this.