unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Allen Li <darkfeline@felesatra.moe>
To: 33372@debbugs.gnu.org
Subject: bug#33372: 26.1; check-coding-systems-region docstring is unclear
Date: Wed, 14 Nov 2018 07:11:42 +0000	[thread overview]
Message-ID: <CADbSrJy839C4-t045FLBRYo76PZ-E9tym6OioZvDuPz3=bXJ9A@mail.gmail.com> (raw)

[-- Attachment #1: Type: text/plain, Size: 184 bytes --]

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.

[-- Attachment #2: 0001-Clarify-check-coding-systems-region-docstring.patch --]
[-- Type: text/x-patch, Size: 1071 bytes --]

From dfcff03d2b2ea13c0c644d636c1ba93c590c56d3 Mon Sep 17 00:00:00 2001
From: Allen Li <darkfeline@felesatra.moe>
Date: Tue, 13 Nov 2018 23:08:26 -0800
Subject: [PATCH] Clarify check-coding-systems-region-docstring

* src/coding.c (Fcheck_coding_systems_region): Clarify docstirng.
---
 src/coding.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/src/coding.c b/src/coding.c
index 966492a322..4bffbf9968 100644
--- a/src/coding.c
+++ b/src/coding.c
@@ -9231,8 +9231,8 @@ DEFUN ("check-coding-systems-region", Fcheck_coding_systems_region,
 START and END are buffer positions specifying the region.
 CODING-SYSTEM-LIST is a list of coding systems to check.
 
-The value is an alist ((CODING-SYSTEM POS0 POS1 ...) ...), where
-CODING-SYSTEM is a member of CODING-SYSTEM-LIST and can't encode the
+The return value is an alist ((CODING-SYSTEM POS0 POS1 ...) ...), where
+CODING-SYSTEM is a member of CODING-SYSTEM-LIST that can't encode the
 whole region, POS0, POS1, ... are buffer positions where non-encodable
 characters are found.
 
-- 
2.19.1


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

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-11-14  7:11 Allen Li [this message]
2018-11-14 16:02 ` bug#33372: 26.1; check-coding-systems-region docstring is unclear 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='CADbSrJy839C4-t045FLBRYo76PZ-E9tym6OioZvDuPz3=bXJ9A@mail.gmail.com' \
    --to=darkfeline@felesatra.moe \
    --cc=33372@debbugs.gnu.org \
    /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).