From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Drew Adams Newsgroups: gmane.emacs.bugs Subject: bug#29328: 24.5; doc string of `transpose-subr` Date: Fri, 17 Nov 2017 07:02:22 -0800 (PST) Message-ID: <93f79e75-eac2-406c-b483-5bf60020a7e4@default> References: <2b3492ed-c7ab-433b-a8ff-3de3c5f38c62@default> <83shddggqe.fsf@gnu.org> NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: quoted-printable X-Trace: blaine.gmane.org 1510931012 10969 195.159.176.226 (17 Nov 2017 15:03:32 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Fri, 17 Nov 2017 15:03:32 +0000 (UTC) Cc: 29328@debbugs.gnu.org To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Fri Nov 17 16:03:24 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 1eFiAr-0002IX-0m for geb-bug-gnu-emacs@m.gmane.org; Fri, 17 Nov 2017 16:03:21 +0100 Original-Received: from localhost ([::1]:46373 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1eFiAy-0002oZ-5j for geb-bug-gnu-emacs@m.gmane.org; Fri, 17 Nov 2017 10:03:28 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:60227) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1eFiAi-0002bH-M7 for bug-gnu-emacs@gnu.org; Fri, 17 Nov 2017 10:03:18 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1eFiAY-0004yy-VN for bug-gnu-emacs@gnu.org; Fri, 17 Nov 2017 10:03:12 -0500 Original-Received: from debbugs.gnu.org ([208.118.235.43]:36471) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1eFiAY-0004yN-Sp for bug-gnu-emacs@gnu.org; Fri, 17 Nov 2017 10:03:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1eFiAY-0001Dq-H6 for bug-gnu-emacs@gnu.org; Fri, 17 Nov 2017 10:03:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Drew Adams Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 17 Nov 2017 15:03:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 29328 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 29328-submit@debbugs.gnu.org id=B29328.15109309554662 (code B ref 29328); Fri, 17 Nov 2017 15:03:02 +0000 Original-Received: (at 29328) by debbugs.gnu.org; 17 Nov 2017 15:02:35 +0000 Original-Received: from localhost ([127.0.0.1]:45152 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1eFiA7-0001D8-Aa for submit@debbugs.gnu.org; Fri, 17 Nov 2017 10:02:35 -0500 Original-Received: from userp1040.oracle.com ([156.151.31.81]:40583) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1eFiA4-0001Ct-1A for 29328@debbugs.gnu.org; Fri, 17 Nov 2017 10:02:32 -0500 Original-Received: from userv0022.oracle.com (userv0022.oracle.com [156.151.31.74]) by userp1040.oracle.com (Sentrion-MTA-4.3.2/Sentrion-MTA-4.3.2) with ESMTP id vAHF2OSf021551 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Fri, 17 Nov 2017 15:02:24 GMT Original-Received: from userv0121.oracle.com (userv0121.oracle.com [156.151.31.72]) by userv0022.oracle.com (8.14.4/8.14.4) with ESMTP id vAHF2Ofp007248 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Fri, 17 Nov 2017 15:02:24 GMT Original-Received: from abhmp0016.oracle.com (abhmp0016.oracle.com [141.146.116.22]) by userv0121.oracle.com (8.14.4/8.13.8) with ESMTP id vAHF2NG6022795; Fri, 17 Nov 2017 15:02:24 GMT In-Reply-To: <83shddggqe.fsf@gnu.org> X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.9.1 (1003210) [OL 16.0.4615.0 (x86)] X-Source-IP: userv0022.oracle.com [156.151.31.74] 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:140009 Archived-At: > > The doc string should describe each parameter. Parameter SPECIAL is > > not described, and its name is not specific or enlightening. >=20 > I don't see how it can be meaningfully documented. That's tantamount to saying that the parameter has no meaning, no behavior. 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?