all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Allen Li <darkfeline@felesatra.moe>
Cc: 33372-done@debbugs.gnu.org
Subject: bug#33372: 26.1; check-coding-systems-region docstring is unclear
Date: Wed, 14 Nov 2018 18:02:15 +0200	[thread overview]
Message-ID: <8336s38x6g.fsf@gnu.org> (raw)
In-Reply-To: <CADbSrJy839C4-t045FLBRYo76PZ-E9tym6OioZvDuPz3=bXJ9A@mail.gmail.com> (message from Allen Li on Wed, 14 Nov 2018 07:11:42 +0000)

> From: Allen Li <darkfeline@felesatra.moe>
> Date: Wed, 14 Nov 2018 07:11:42 +0000
> 
> The docstring for check-coding-systems-region docstring is unclear and
> has a typo.
> 
> Attached is a patch fixing it.  The patch is against master, but I
> imagine it can be applied to 26.

Thanks.  I installed on the emacs-26 branch a more thorough fix of the
doc string, since the original one had additional issues.

One comment for the future: "The value is ..." or even just "Value is
..." is standard terminology in Emacs documentation, you will find
gobs of such phrases all over the places.  You will find much fewer
"The return value is ...".  So this particular part of the doc string
is not something that needs fixing, it's just something to get used
to.





      reply	other threads:[~2018-11-14 16:02 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-11-14  7:11 bug#33372: 26.1; check-coding-systems-region docstring is unclear Allen Li
2018-11-14 16:02 ` Eli Zaretskii [this message]

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=8336s38x6g.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=33372-done@debbugs.gnu.org \
    --cc=darkfeline@felesatra.moe \
    /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.