From: Drew Adams <drew.adams@oracle.com>
To: John Wiegley <jwiegley@gmail.com>,
Philipp Stephani <p.stephani2@gmail.com>
Cc: Emacs developers <emacs-devel@gnu.org>
Subject: RE: Small docstring improvements
Date: Fri, 19 Aug 2016 15:04:07 -0700 (PDT) [thread overview]
Message-ID: <b9ddfe87-83c1-44bc-ac67-cb3094b3866f@default> (raw)
In-Reply-To: <m2zio8tqct.fsf@newartisans.com>
> Yes, agreed with respect to your patch, disagree only with respect to what
> you found there. :) Those explicit branches shouldn't have been written. It
> sounds like its purely an attempt to avoid creating new functions for what is
> clearly new functionality.
FWIW, I disagree. I have no problem with a parameter having
different uses and different types (buffer position, string, nil).
It could be argued that the parameter name does not reflect all
of the use cases, or that it should have a generic name, such as
ARG, because of the multiple uses. But a buffer-position is the
common use case, and I don't have a problem with the name "START",
as long as the doc clearly specifies the full behavior.
FWIW2, it is not a new feature. From the Emacs 20 doc string for
`write-region' - but the writer seems to agree with you that this
(handy) feature is a kludge:
Kludgy feature: if START is a string, then that string is written
to the file, instead of any buffer contents, and END is ignored.
The use of a `nil' value for START was added in Emacs 22. At the
same time, the characterization of multiple-use START as a kludge
was removed.
next prev parent reply other threads:[~2016-08-19 22:04 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-08-19 19:26 Small docstring improvements Philipp Stephani
2016-08-19 19:34 ` John Wiegley
2016-08-19 20:34 ` Philipp Stephani
2016-08-19 21:12 ` John Wiegley
2016-08-19 22:04 ` Drew Adams [this message]
2016-08-20 0:24 ` John Wiegley
2016-08-20 7:10 ` Eli Zaretskii
2016-08-20 23:17 ` John Wiegley
2016-08-19 21:59 ` Dmitry Gutov
2016-08-20 7:08 ` Eli Zaretskii
2016-08-20 13:52 ` Philipp Stephani
2016-08-20 15:34 ` Eli Zaretskii
2016-08-20 15:59 ` Philipp Stephani
2016-08-20 16:11 ` Eli Zaretskii
2016-08-20 18:00 ` Philipp Stephani
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=b9ddfe87-83c1-44bc-ac67-cb3094b3866f@default \
--to=drew.adams@oracle.com \
--cc=emacs-devel@gnu.org \
--cc=jwiegley@gmail.com \
--cc=p.stephani2@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 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.