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:36:28 -0800 (PST) Message-ID: <7ca7abc6-f456-419e-be2d-b3c06b45ca72@default> References: <2b3492ed-c7ab-433b-a8ff-3de3c5f38c62@default> <83shddggqe.fsf@gnu.org> <93f79e75-eac2-406c-b483-5bf60020a7e4@default> NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Trace: blaine.gmane.org 1510933031 4092 195.159.176.226 (17 Nov 2017 15:37:11 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Fri, 17 Nov 2017 15:37:11 +0000 (UTC) Cc: 29328@debbugs.gnu.org To: Noam Postavsky Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Fri Nov 17 16:37:07 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 1eFihX-0000lD-2y for geb-bug-gnu-emacs@m.gmane.org; Fri, 17 Nov 2017 16:37:07 +0100 Original-Received: from localhost ([::1]:46492 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1eFihe-0007j1-6p for geb-bug-gnu-emacs@m.gmane.org; Fri, 17 Nov 2017 10:37:14 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:42655) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1eFihV-0007iu-4A for bug-gnu-emacs@gnu.org; Fri, 17 Nov 2017 10:37:09 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1eFihS-0006Vi-0y for bug-gnu-emacs@gnu.org; Fri, 17 Nov 2017 10:37:05 -0500 Original-Received: from debbugs.gnu.org ([208.118.235.43]:36494) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1eFihR-0006VV-Su for bug-gnu-emacs@gnu.org; Fri, 17 Nov 2017 10:37:01 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1eFihR-00020T-MW for bug-gnu-emacs@gnu.org; Fri, 17 Nov 2017 10:37:01 -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:37:01 +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.15109330017677 (code B ref 29328); Fri, 17 Nov 2017 15:37:01 +0000 Original-Received: (at 29328) by debbugs.gnu.org; 17 Nov 2017 15:36:41 +0000 Original-Received: from localhost ([127.0.0.1]:45174 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1eFih7-0001zk-G7 for submit@debbugs.gnu.org; Fri, 17 Nov 2017 10:36:41 -0500 Original-Received: from userp1040.oracle.com ([156.151.31.81]:26113) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1eFih4-0001zU-4Y for 29328@debbugs.gnu.org; Fri, 17 Nov 2017 10:36:38 -0500 Original-Received: from aserv0022.oracle.com (aserv0022.oracle.com [141.146.126.234]) by userp1040.oracle.com (Sentrion-MTA-4.3.2/Sentrion-MTA-4.3.2) with ESMTP id vAHFaVBw030866 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Fri, 17 Nov 2017 15:36:31 GMT Original-Received: from userv0121.oracle.com (userv0121.oracle.com [156.151.31.72]) by aserv0022.oracle.com (8.14.4/8.14.4) with ESMTP id vAHFaUq9023907 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Fri, 17 Nov 2017 15:36:31 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 vAHFaTia011365; Fri, 17 Nov 2017 15:36:30 GMT In-Reply-To: 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: aserv0022.oracle.com [141.146.126.234] 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:140011 Archived-At: > >> > 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. 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? >=20 > How about something like this: > -forward-paragraph). If ARG is zero, exchanges the current object > +forward-paragraph). If SPECIAL is non-nil, then MOVER should > +return the bounds of the object as a cons (BEG . END) instead. > +If ARG is zero, exchanges the current object > with the one containing mark. If ARG is an integer, moves the > current object past ARG following (if ARG is positive) or > preceding (if ARG is negative) objects, leaving point after the If that's the behavior, fine with me. I don't know what the behavior is. But the parameters should be described in order, i.e., ARGS should be described before SPECIAL.