all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Jean-Christophe Helary <jean.christophe.helary@gmail.com>
Cc: 26925@debbugs.gnu.org, stephen.berman@gmx.net, michael.albinus@gmx.de
Subject: bug#26925: Improve /doc/lispref/strings.texi (split-string) documentation
Date: Mon, 05 Jun 2017 05:46:48 +0300	[thread overview]
Message-ID: <83r2yz9mnb.fsf@gnu.org> (raw)
In-Reply-To: <E1B62C05-C4D7-4580-B2C1-35CE21F6BA40@gmail.com> (message from Jean-Christophe Helary on Mon, 5 Jun 2017 09:33:37 +0900)

> From: Jean-Christophe Helary <jean.christophe.helary@gmail.com>
> Date: Mon, 5 Jun 2017 09:33:37 +0900
> Cc: michael.albinus@gmx.de,
>  26925@debbugs.gnu.org,
>  stephen.berman@gmx.net
> 
> It is not about me being happy or not, but about me learning what's correct and what is not. If you tell me that it is not correct to worry about various styles being used seemingly at random, then I learn from that. If you tell me that it is not necessary, which you did, then I can argue that I feel better if the few lines I was involved with are tidied up.

I'm not sure I understand the last sentence, but if I do, then no, you
shouldn't worry about random changes of style, as long as the text is
accurate and is correct English.  This is, after all, descriptive
text in plain English, not a formal document.

> >> No, because in the function signature they are defined as optional.
> > 
> > And yet we usually do say explicitly in doc strings that optional
> > arguments are optional.
> 
> Does that mean that you suggest we explicitly declare them optional in split-string ?

Yes, I think so.





  reply	other threads:[~2017-06-05  2:46 UTC|newest]

Thread overview: 23+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-05-14 15:45 bug#26925: Improve /doc/lispref/strings.texi (split-string) documentation Jean-Christophe Helary
2017-05-19 11:47 ` Eli Zaretskii
2017-05-19 12:23   ` Jean-Christophe Helary
2017-05-19 12:56     ` Eli Zaretskii
2017-05-19 13:02       ` Jean-Christophe Helary
2017-05-19 13:30       ` Stephen Berman
2017-06-03  8:50         ` Jean-Christophe Helary
2017-06-03  9:59           ` Eli Zaretskii
2017-06-03 13:50             ` Jean-Christophe Helary
2017-06-03 14:46               ` Eli Zaretskii
2017-06-03 23:45                 ` Jean-Christophe Helary
2017-06-04  2:38                   ` Eli Zaretskii
2017-06-04  7:49                     ` Michael Albinus
2017-06-04  9:19                       ` Jean-Christophe Helary
2017-06-04 13:57                       ` Eli Zaretskii
2017-06-04 15:14                         ` Jean-Christophe Helary
2017-06-04 15:46                           ` Eli Zaretskii
2017-06-05  0:33                             ` Jean-Christophe Helary
2017-06-05  2:46                               ` Eli Zaretskii [this message]
2017-06-05  3:31                                 ` Jean-Christophe Helary
2017-06-05  5:15                                   ` Jean-Christophe Helary
2017-06-05 15:09                                     ` Eli Zaretskii
2017-06-05 21:24                                       ` Jean-Christophe Helary

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

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

  git send-email \
    --in-reply-to=83r2yz9mnb.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=26925@debbugs.gnu.org \
    --cc=jean.christophe.helary@gmail.com \
    --cc=michael.albinus@gmx.de \
    --cc=stephen.berman@gmx.net \
    /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 external index

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

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.