From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#33372: 26.1; check-coding-systems-region docstring is unclear Date: Wed, 14 Nov 2018 18:02:15 +0200 Message-ID: <8336s38x6g.fsf@gnu.org> References: NNTP-Posting-Host: blaine.gmane.org X-Trace: blaine.gmane.org 1542211283 3585 195.159.176.226 (14 Nov 2018 16:01:23 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Wed, 14 Nov 2018 16:01:23 +0000 (UTC) Cc: 33372-done@debbugs.gnu.org To: Allen Li Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Wed Nov 14 17:01:19 2018 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by blaine.gmane.org with esmtp (Exim 4.84_2) (envelope-from ) id 1gMxbP-0000lL-7h for geb-bug-gnu-emacs@m.gmane.org; Wed, 14 Nov 2018 17:01:15 +0100 Original-Received: from localhost ([::1]:32918 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gMxdV-00059o-6N for geb-bug-gnu-emacs@m.gmane.org; Wed, 14 Nov 2018 11:03:25 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:35867) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gMxdE-000563-Tz for bug-gnu-emacs@gnu.org; Wed, 14 Nov 2018 11:03:09 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1gMxd9-0007JX-Vy for bug-gnu-emacs@gnu.org; Wed, 14 Nov 2018 11:03:08 -0500 Original-Received: from debbugs.gnu.org ([208.118.235.43]:48182) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1gMxd9-0007IY-Rb for bug-gnu-emacs@gnu.org; Wed, 14 Nov 2018 11:03:03 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1gMxd9-0003jX-La for bug-gnu-emacs@gnu.org; Wed, 14 Nov 2018 11:03:03 -0500 Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-To: bug-gnu-emacs@gnu.org Resent-Date: Wed, 14 Nov 2018 16:03:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: cc-closed 33372 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Mail-Followup-To: 33372@debbugs.gnu.org, eliz@gnu.org, darkfeline@felesatra.moe Original-Received: via spool by 33372-done@debbugs.gnu.org id=D33372.154221136014314 (code D ref 33372); Wed, 14 Nov 2018 16:03:02 +0000 Original-Received: (at 33372-done) by debbugs.gnu.org; 14 Nov 2018 16:02:40 +0000 Original-Received: from localhost ([127.0.0.1]:52439 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1gMxcm-0003in-81 for submit@debbugs.gnu.org; Wed, 14 Nov 2018 11:02:40 -0500 Original-Received: from eggs.gnu.org ([208.118.235.92]:53924) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1gMxck-0003iZ-RP for 33372-done@debbugs.gnu.org; Wed, 14 Nov 2018 11:02:39 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1gMxcR-0006Zo-Me for 33372-done@debbugs.gnu.org; Wed, 14 Nov 2018 11:02:27 -0500 Original-Received: from fencepost.gnu.org ([2001:4830:134:3::e]:39785) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gMxcP-0006YU-0d; Wed, 14 Nov 2018 11:02:17 -0500 Original-Received: from [176.228.60.248] (port=2882 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1gMxcO-0002uU-CP; Wed, 14 Nov 2018 11:02:16 -0500 In-reply-to: (message from Allen Li on Wed, 14 Nov 2018 07:11:42 +0000) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 208.118.235.43 X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.org gmane.emacs.bugs:152387 Archived-At: > From: Allen Li > 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.