From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.ciao.gmane.io!not-for-mail From: =?UTF-8?Q?=C5=A0t=C4=9Bp=C3=A1n_?= =?UTF-8?Q?N=C4=9Bmec?= Newsgroups: gmane.emacs.bugs Subject: bug#40695: [PATCH] ; Fix some typos and doc issues Date: Sat, 18 Apr 2020 15:13:27 +0200 Message-ID: <87mu796io8.fsf@gmail.com> References: <20200418113735.34298-1-stepnem@gmail.com> <833691asgx.fsf@gnu.org> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Injection-Info: ciao.gmane.io; posting-host="ciao.gmane.io:159.69.161.202"; logging-data="59793"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.0.50 (gnu/linux) Cc: 40695@debbugs.gnu.org To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sat Apr 18 15:13:22 2020 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1jPnHd-000FRQ-Rs for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 18 Apr 2020 15:13:21 +0200 Original-Received: from localhost ([::1]:57826 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jPnHc-0000Uf-FC for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 18 Apr 2020 09:13:20 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:50475) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jPnHM-0000IC-0N for bug-gnu-emacs@gnu.org; Sat, 18 Apr 2020 09:13:05 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1jPnHK-0007jR-Gn for bug-gnu-emacs@gnu.org; Sat, 18 Apr 2020 09:13:03 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:58852) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1jPnHK-0007iq-D8 for bug-gnu-emacs@gnu.org; Sat, 18 Apr 2020 09:13:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1jPnHK-0004bW-9A for bug-gnu-emacs@gnu.org; Sat, 18 Apr 2020 09:13:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: =?UTF-8?Q?=C5=A0t=C4=9Bp=C3=A1n_?= =?UTF-8?Q?N=C4=9Bmec?= Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 18 Apr 2020 13:13:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 40695 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 40695-submit@debbugs.gnu.org id=B40695.158721557317679 (code B ref 40695); Sat, 18 Apr 2020 13:13:02 +0000 Original-Received: (at 40695) by debbugs.gnu.org; 18 Apr 2020 13:12:53 +0000 Original-Received: from localhost ([127.0.0.1]:42165 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1jPnHB-0004b4-DX for submit@debbugs.gnu.org; Sat, 18 Apr 2020 09:12:53 -0400 Original-Received: from mail-wm1-f67.google.com ([209.85.128.67]:55402) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1jPnHA-0004ar-16 for 40695@debbugs.gnu.org; Sat, 18 Apr 2020 09:12:52 -0400 Original-Received: by mail-wm1-f67.google.com with SMTP id e26so5602224wmk.5 for <40695@debbugs.gnu.org>; Sat, 18 Apr 2020 06:12:52 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:in-reply-to:references:user-agent:date :message-id:mime-version:content-transfer-encoding; bh=1YlPguzbMxGRI77QVoq66NkCG3gIFDKTtwtl87bZ4jE=; b=UsakvS+CN4y1PCCnq1o8SUqyAy5+P0bMObc3CbaA1jEfIxKlS5QrjHIdF0eQqDUN0I dDc5cTkjeinF2xxAcf/Fgwk+O9aFP4qFpNhEvt8FzSTNVWwpobrt2vxOX8qXAxMoyUOL LF7B3yteqE9KdL0yErg7Y0ex9DivC33PqY1sBBVagSQgMCiZUbgPe4jDKvSh7h/RusqF 1WhQvP+CwLVum79ivFgo5+f+jRJBTs1aNZPrXu4x86Kx8zWl5F/zfLEERyL/cxUAG8K5 Fn3fz6SAWj3WCKTwSgRPfVgcgCU0NvXnrG6dpR51mdVFV7C+zE1oqXApscMFho26op2g o8yA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:in-reply-to:references :user-agent:date:message-id:mime-version:content-transfer-encoding; bh=1YlPguzbMxGRI77QVoq66NkCG3gIFDKTtwtl87bZ4jE=; b=a7dGKei2lvUXwNkpWrRiWi6+dUi1KL4LBgZTiJLu6KYz72eqo8mBM2c1xvYbDhIu0Z Jdvvt45eco0oj1EwUFeGfbtdVg27daQcJePov4dIF+Cuo2cyXQHLFR2AthToE+mDPsBb 8jVbnbaXoHeFnM0FM2Nk6x9RXqE89kLvSI9mpLCR3PJY6m7vjdpc4yP6FT10yp8WCr1E Fj9qZjzYBNd5gH6HrNl88A0XVoN48rt77f7KQ+5exYB8AGeaaybG0EMPWkdr3zA/ivMD d6G7XkZ9lkPA/jfe/Y+pAKSRJXAE4sHM54p7lQOs56G37cYZxjdR75XVXWY0MN9zwPvj KKDQ== X-Gm-Message-State: AGi0PubFNB1/18agPuvFONXUd9o8lhYudqhJx4fctEtCY1AYnXIKoEN8 qq76MHLQ5K8L3KZJPIIEnQo= X-Google-Smtp-Source: APiQypJ7zSaDPkAlSO2xIZUUKYgsS8jV3g2xz+apltMeHUpRSku+FTa4YcPBx3mMjAMxYtNzrJza8w== X-Received: by 2002:a1c:9d0d:: with SMTP id g13mr8553092wme.102.1587215566081; Sat, 18 Apr 2020 06:12:46 -0700 (PDT) Original-Received: from localhost ([185.112.167.47]) by smtp.gmail.com with ESMTPSA id s6sm11451818wmh.17.2020.04.18.06.12.45 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 18 Apr 2020 06:12:45 -0700 (PDT) In-Reply-To: <833691asgx.fsf@gnu.org> (Eli Zaretskii's message of "Sat, 18 Apr 2020 15:28:14 +0300") 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: 209.51.188.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-mx.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.io gmane.emacs.bugs:178570 Archived-At: On Sat, 18 Apr 2020 15:28:14 +0300 Eli Zaretskii wrote: > Are all of the places where you inserted @w{..} split expressions or > commands between lines? I don't want to have redundant @w{..} in the > manual sources. Not all of them, but I thought that we established in https://lists.gnu.org/archive/html/bug-gnu-emacs/2020-04/msg00245.html 835ze8o53t.fsf@gnu.org that the only way to be sure is to always check the rendered output if a change pushed a previously non-split occurence to a location where the split happens. And given your "@w{..} is harmless if it isn't needed" in the above-mentioned message, I decided to err on the redundant side, as I suspect most people don't routinely double-check the Info output after every change. If you prefer to limit the changes to only those necessary for unsplitting the already split occurences, I'll do that. >> -@strong{Warning:} if the changes you combine occur in widely scattered >> +@strong{Warning:} If the changes you combine occur in widely scattered > > Not sure the original text is a typo. Indeed, it caught my eye for the reasons of consistency: all the other "Warning:"s in text.texi, and most of those in other texi files, do start with a capital, but not all of them, so if it seems too petty to you I'll revert this (personally I dislike needless churn; e.g. I was quite hesitant about the signalled -> signaled, too; I just bumped into it inadvertently). >> --- a/lisp/emacs-lisp/cl-macs.el >> +++ b/lisp/emacs-lisp/cl-macs.el >> @@ -776,7 +776,7 @@ cl-case >> "Eval EXPR and choose among clauses on that value. >> Each clause looks like (KEYLIST BODY...). EXPR is evaluated and >> compared against each key in each KEYLIST; the corresponding BODY >> -is evaluated. If no clause succeeds, cl-case returns nil. A >> +is evaluated. If no clause succeeds, `cl-case' returns nil. A > > I'd prefer to say "this macro" here. It doesn't seem useful to have a > link to the macro from its own doc string. Indeed, I'll change that, thanks. >> -;; `iter-do' is like `cl-do', except that instead of walking a list, >> +;; `iter-do' is like `dolist', except that instead of walking a list, > > Is the original text in error here? "Error" might be too strong, but `iter-do' is very similar (analogous) to `dolist', and quite dissimilar to `cl-do', so I find the original comparison more confusing than helpful (and indeed suspect that it might have been an oversight/thinko). >> (defvar cps--dynamic-wrappers '(identity) >> - "List of transformer functions to apply to atomic forms we >> -evaluate in CPS context.") >> + "\ >> +List of transformer functions applied to atomic forms evaluated in CPS = context." >> + ) > > This should be fixed by making the sentence shorter. The sentence is > a mouthful, IMO. Heh. I did think about this really hard, but couldn't come up with anything that would fit on a single line and not lose essential information. Do you have any concrete suggestions? >> (defun cps--atomic-p (form) >> - "Return whether the given form never yields." >> - >> + "Return non-nil if FORM never yields." > > Why this change? The original sentence sounds weird to me (what does the function really return?), while the new version should be quite clear IMO. There's also checkdoc nagging about `form' not being upper case. >> - "Return whether the given form never yields." >> -like `try-completion'; if it's t, this function works like >> -`all-completion'; and any other values makes it work like >> +like `try-completion'; if it is t, this function works like >> +`all-completion'; and any other value makes it work like > > What was wrong here? "values makes" -> "value makes"; when at it, I also ended up changing "it's" to "it is", as I found the former too informal or something... Thanks, =C5=A0t=C4=9Bp=C3=A1n