bug#33372: 26.1; check-coding-systems-region docstring is unclear

bug#33372: 26.1; check-coding-systems-region docstring is unclear

[Allen Li]

[-- 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

bug#33372: 26.1; check-coding-systems-region docstring is unclear

[Eli Zaretskii]

> 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.