[debbugs-tracker] bug#33372: closed (26.1; check-coding-systems-region docstring is unclear)

[GNU bug Tracking System]

Your message dated Wed, 14 Nov 2018 18:02:15 +0200
with message-id <address@hidden>
and subject line Re: bug#33372: 26.1; check-coding-systems-region docstring is 
unclear
has caused the debbugs.gnu.org bug report #33372,
regarding 26.1; check-coding-systems-region docstring is unclear
to be marked as done.

(If you believe you have received this mail in error, please contact
address@hidden)


-- 
33372: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=33372
GNU Bug Tracking System
Contact address@hidden with problems

--- Begin Message --- Subject: 26.1; check-coding-systems-region docstring is unclear 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.

0001-Clarify-check-coding-systems-region-docstring.patch
Description: Text Data

--- End Message ---

> --- Begin Message ---
>
>
>
> Subject: 
>
> Re: bug#33372: 26.1; check-coding-systems-region docstring is unclear
>
>
>
>
> Date: 
>
> Wed, 14 Nov 2018 18:02:15 +0200
>
>
>
>
> > From: Allen Li <address@hidden>
> > 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.
>
>
> --- End Message ---