unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Xiyue Deng <manphiz@gmail.com>
Cc: 67820@debbugs.gnu.org
Subject: bug#67820: 29.1; Code example in "fwd-para while" has unmatched ending parentheses
Date: Sat, 16 Dec 2023 09:52:40 +0200	[thread overview]
Message-ID: <838r5uoa7r.fsf@gnu.org> (raw)
In-Reply-To: <87cyv7jez0.fsf@debian-hx90.lan> (message from Xiyue Deng on Fri,  15 Dec 2023 14:08:51 -0800)

> From: Xiyue Deng <manphiz@gmail.com>
> Cc: 67820@debbugs.gnu.org
> Date: Fri, 15 Dec 2023 14:08:51 -0800
> 
> Eli Zaretskii <eliz@gnu.org> writes:
> 
> >> From: Xiyue Deng <manphiz@gmail.com>
> >> Date: Wed, 13 Dec 2023 21:55:55 -0800
> >> 
> >> 
> >> The code example in section "fwd-para while" has unmatched ending
> >> parentheses[1].  Admittedly this code snippet was copied literally from
> >> the previous longer code sample where the 2 extra ending parentheses
> >> were to match the `if' and `while', but it would make more sense to drop
> >> them in this example.  Will add a patch next.
> >
> > I'm not sure it makes sense to make this expression stand-alone.  As
> > you say, this snippet is copied verbatim from the full example at the
> > beginning of the section.  So I think we should leave this alone.
> >
> > Thanks.
> 
> This essentially was due to the coding convention to put all ending
> parentheses on the last line of the sexp, which most other programming
> languages don't normally share.  But anyway.
> 
> Just want to say that a code snippet with unmatched ending parentheses
> would confuse beginners a little.  However, if from a book writing point
> of view that code snippets should be copied literally, it's probably
> understandable (adding a small explanation for the extras would better
> still, and I can update the patch accordingly.)
> 
> Wdyt?

It's okay to add a note in parentheses that this snippet is from the
above full code, and therefore is not standalone.





  reply	other threads:[~2023-12-16  7:52 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-12-14  5:55 bug#67820: 29.1; Code example in "fwd-para while" has unmatched ending parentheses Xiyue Deng
     [not found] ` <handler.67820.B.170253338629937.ack@debbugs.gnu.org>
2023-12-14  6:00   ` bug#67820: Acknowledgement (29.1; Code example in "fwd-para while" has unmatched ending parentheses) Xiyue Deng
2023-12-15 13:37 ` bug#67820: 29.1; Code example in "fwd-para while" has unmatched ending parentheses Eli Zaretskii
2023-12-15 22:08   ` Xiyue Deng
2023-12-16  7:52     ` Eli Zaretskii [this message]
2023-12-16 10:46       ` Xiyue Deng
2023-12-16 13:40         ` Eli Zaretskii
2023-12-16 22:57           ` Xiyue Deng
2023-12-23  9:38             ` Eli Zaretskii

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=838r5uoa7r.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=67820@debbugs.gnu.org \
    --cc=manphiz@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).