From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED.blaine.gmane.org!not-for-mail From: Stefan Kangas Newsgroups: gmane.emacs.bugs Subject: bug#36206: [PATCH] Change `user-error' docstring from "pilot error" to "user error" Date: Fri, 14 Jun 2019 13:09:06 +0200 Message-ID: Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="000000000000797746058b46ad10" Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="41797"; mail-complaints-to="usenet@blaine.gmane.org" To: 36206@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Fri Jun 14 13:29:15 2019 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([209.51.188.17]) by blaine.gmane.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.89) (envelope-from ) id 1hbkOQ-000AiI-VB for geb-bug-gnu-emacs@m.gmane.org; Fri, 14 Jun 2019 13:29:15 +0200 Original-Received: from localhost ([::1]:50318 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.86_2) (envelope-from ) id 1hbkOQ-00055z-0t for geb-bug-gnu-emacs@m.gmane.org; Fri, 14 Jun 2019 07:29:14 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:36318) by lists.gnu.org with esmtp (Exim 4.86_2) (envelope-from ) id 1hbkCi-0002w7-1v for bug-gnu-emacs@gnu.org; Fri, 14 Jun 2019 07:17:10 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1hbkCf-0003PG-Td for bug-gnu-emacs@gnu.org; Fri, 14 Jun 2019 07:17:07 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:51321) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1hbkCc-0003Mx-6G for bug-gnu-emacs@gnu.org; Fri, 14 Jun 2019 07:17:03 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1hbkCc-0000i9-0g for bug-gnu-emacs@gnu.org; Fri, 14 Jun 2019 07:17:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Stefan Kangas Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 14 Jun 2019 11:17:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 36206 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Original-Received: via spool by submit@debbugs.gnu.org id=B.15605110212721 (code B ref -1); Fri, 14 Jun 2019 11:17:01 +0000 Original-Received: (at submit) by debbugs.gnu.org; 14 Jun 2019 11:17:01 +0000 Original-Received: from localhost ([127.0.0.1]:36632 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1hbkCY-0000hm-BD for submit@debbugs.gnu.org; Fri, 14 Jun 2019 07:16:58 -0400 Original-Received: from lists.gnu.org ([209.51.188.17]:58888) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1hbkCW-0000hd-Jv for submit@debbugs.gnu.org; Fri, 14 Jun 2019 07:16:56 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:35940) by lists.gnu.org with esmtp (Exim 4.86_2) (envelope-from ) id 1hbkCU-0002Vi-US for bug-gnu-emacs@gnu.org; Fri, 14 Jun 2019 07:16:56 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1hbk59-00033m-Mw for bug-gnu-emacs@gnu.org; Fri, 14 Jun 2019 07:09:20 -0400 Original-Received: from mail-wm1-f41.google.com ([209.85.128.41]:33125) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1hbk59-00033F-GH for bug-gnu-emacs@gnu.org; Fri, 14 Jun 2019 07:09:19 -0400 Original-Received: by mail-wm1-f41.google.com with SMTP id h19so8654963wme.0 for ; Fri, 14 Jun 2019 04:09:19 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:from:date:message-id:subject:to; bh=U2lwjObgJMSA+mb+nvsZRdHk1HrnTPVhHOdp10ZVvEk=; b=XBZ7loSd3QviVUwOWVsF963+h5WqYATauWbxRrMsNOLUuzWRpuAS5AdgAh6J68yed6 gpzEIIQ6w/tSVzVB6P1fI/e+kbI4n/2KQKNtfYz55mRibhN1LVqTEARqozXgul2AWwqG fyRqd8ZfMBV++06g/aYTh/igsp9DOZIpu59pSNoZuqly3FxKemBI5SMhcHySE78/8D17 Ox2TwUsInL3mqh9/HWuuS3tGCLblwsrhdabKzmSdoUHxMf9AAYcF3FVJTMZOmUqQMSqb aMj0yvvG6cvkdC4lsr3eNDrhgeoFneLYzDwUhsvGuhRTAGOh+EFXrWeffjuS0maWoZUR dCUQ== X-Gm-Message-State: APjAAAWrt18TJzkbxAHkrSSv0dcDp8TrhY/k257fJzXy/Yj/ouxMTJca /1r0aZWbEXyNt6136nC/jv7fZHuQ7iwzntJBMjNM84rs X-Google-Smtp-Source: APXvYqyP8kxIbLFvT1QDj5K3UXs6aPm9Nzh3Z+e838vEUOeEL58+t1CMqEMJfx3reA6S2heqDJEdv2Eizb/hye7QZRU= X-Received: by 2002:a1c:cb0c:: with SMTP id b12mr7662974wmg.93.1560510557833; Fri, 14 Jun 2019 04:09:17 -0700 (PDT) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] 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: 209.51.188.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:160549 Archived-At: --000000000000797746058b46ad10 Content-Type: text/plain; charset="UTF-8" The documentation of `user-error' says that it will "Signal a pilot error", which I personally find confusing. For starters, "pilot" could also mean "done as an experiment or test before being introduced more widely". It's more clear to say "user error". I don't have any data on this, but in my experience this is also more in line with how other programming languages names this class of errors. See the attached patch for my suggested improvements. Thanks, Stefan Kangas --000000000000797746058b46ad10 Content-Type: text/x-patch; charset="US-ASCII"; name="0001-Clarify-error-and-user-error-docstrings.patch" Content-Disposition: attachment; filename="0001-Clarify-error-and-user-error-docstrings.patch" Content-Transfer-Encoding: base64 Content-ID: X-Attachment-Id: f_jwvzljea0 RnJvbSA3YzljZWJiNGZjNzMyNDU1ZTc2M2RiMjE1NzZmNjI3ODc3ODhkNjNhIE1vbiBTZXAgMTcg MDA6MDA6MDAgMjAwMQpGcm9tOiBTdGVmYW4gS2FuZ2FzIDxzdGVmYW5rYW5nYXNAZ21haWwuY29t PgpEYXRlOiBGcmksIDE0IEp1biAyMDE5IDEyOjIzOjM4ICswMjAwClN1YmplY3Q6IFtQQVRDSF0g Q2xhcmlmeSBlcnJvciBhbmQgdXNlci1lcnJvciBkb2NzdHJpbmdzCgoqIGxpc3Avc3Vici5lbCAo ZXJyb3IsIHVzZXItZXJyb3IpCiogbGlzcC9uZXQvdHJhbXAuZWwgKHRyYW1wLXVzZXItZXJyb3Ip OiBDaGFuZ2UgInBpbG90IGVycm9yIiB0byAidXNlcgplcnJvciIgYW5kIGltcHJvdmUgZG9jdW1l bnRhdGlvbi4KLS0tCiBsaXNwL25ldC90cmFtcC5lbCB8ICAyICstCiBsaXNwL3N1YnIuZWwgICAg ICB8IDE1ICsrKysrKysrKystLS0tLQogMiBmaWxlcyBjaGFuZ2VkLCAxMSBpbnNlcnRpb25zKCsp LCA2IGRlbGV0aW9ucygtKQoKZGlmZiAtLWdpdCBhL2xpc3AvbmV0L3RyYW1wLmVsIGIvbGlzcC9u ZXQvdHJhbXAuZWwKaW5kZXggNzZlYjAzYjg5ZS4uMjNlMjA2NTc4OCAxMDA2NDQKLS0tIGEvbGlz cC9uZXQvdHJhbXAuZWwKKysrIGIvbGlzcC9uZXQvdHJhbXAuZWwKQEAgLTE4NTksNyArMTg1OSw3 IEBAIHRyYW1wLWVycm9yLXdpdGgtYnVmZmVyCiAKIDs7IFdlIG11c3QgbWFrZSBpdCBhIGRlZnVu LCBiZWNhdXNlIGl0IGlzIHVzZWQgZWFybGllciBhbHJlYWR5LgogKGRlZnVuIHRyYW1wLXVzZXIt ZXJyb3IgKHZlYy1vci1wcm9jIGZtdC1zdHJpbmcgJnJlc3QgYXJndW1lbnRzKQotICAiU2lnbmFs IGEgcGlsb3QgZXJyb3IuIgorICAiU2lnbmFsIGEgdXNlciBlcnJvci4iCiAgICh1bndpbmQtcHJv dGVjdAogICAgICAgKGFwcGx5CiAgICAgICAgIyd0cmFtcC1lcnJvciB2ZWMtb3ItcHJvYwpkaWZm IC0tZ2l0IGEvbGlzcC9zdWJyLmVsIGIvbGlzcC9zdWJyLmVsCmluZGV4IDkzYTk4YTRiZGIuLmYy MGM4NjVkMjcgMTAwNjQ0Ci0tLSBhL2xpc3Avc3Vici5lbAorKysgYi9saXNwL3N1YnIuZWwKQEAg LTMyNiwxMCArMzI2LDEyIEBAIGlnbm9yZQogCiA7OyBTaWduYWwgYSBjb21waWxlLWVycm9yIGlm IHRoZSBmaXJzdCBhcmcgaXMgbWlzc2luZy4KIChkZWZ1biBlcnJvciAoJnJlc3QgYXJncykKLSAg IlNpZ25hbCBhbiBlcnJvciwgbWFraW5nIGEgbWVzc2FnZSBieSBwYXNzaW5nIGFyZ3MgdG8gYGZv cm1hdC1tZXNzYWdlJy4KKyAgIlNpZ25hbCBhbiBlcnJvciwgbWFraW5nIGEgbWVzc2FnZSBieSBw YXNzaW5nIEFSR1MgdG8gYGZvcm1hdC1tZXNzYWdlJy4KIEluIEVtYWNzLCB0aGUgY29udmVudGlv biBpcyB0aGF0IGVycm9yIG1lc3NhZ2VzIHN0YXJ0IHdpdGggYSBjYXBpdGFsCiBsZXR0ZXIgYnV0 ICpkbyBub3QqIGVuZCB3aXRoIGEgcGVyaW9kLiAgUGxlYXNlIGZvbGxvdyB0aGlzIGNvbnZlbnRp b24KIGZvciB0aGUgc2FrZSBvZiBjb25zaXN0ZW5jeS4KK0Vycm9ycyBjYXVzZSBlbnRyeSB0byB0 aGUgZGVidWdnZXIgd2hlbiBgZGVidWctb24tZXJyb3InIGlzCitub24tbmlsLiAgVGhpcyBjYW4g YmUgb3ZlcnJpZGRlbiBieSBgZGVidWctaWdub3JlZC1lcnJvcnMnLgogCiBOb3RlOiAoZXJyb3Ig XCIlc1wiIFZBTFVFKSBtYWtlcyB0aGUgbWVzc2FnZSBWQUxVRSB3aXRob3V0CiBpbnRlcnByZXRp bmcgZm9ybWF0IGNoYXJhY3RlcnMgbGlrZSBgJScsIGBcXD1gJywgYW5kIGBcXD0nJy4iCkBAIC0z MzcsMTMgKzMzOSwxNiBAQCBlcnJvcgogICAoc2lnbmFsICdlcnJvciAobGlzdCAoYXBwbHkgIydm b3JtYXQtbWVzc2FnZSBhcmdzKSkpKQogCiAoZGVmdW4gdXNlci1lcnJvciAoZm9ybWF0ICZyZXN0 IGFyZ3MpCi0gICJTaWduYWwgYSBwaWxvdCBlcnJvciwgbWFraW5nIGEgbWVzc2FnZSBieSBwYXNz aW5nIGFyZ3MgdG8gYGZvcm1hdC1tZXNzYWdlJy4KLUluIEVtYWNzLCB0aGUgY29udmVudGlvbiBp cyB0aGF0IGVycm9yIG1lc3NhZ2VzIHN0YXJ0IHdpdGggYSBjYXBpdGFsCi1sZXR0ZXIgYnV0ICpk byBub3QqIGVuZCB3aXRoIGEgcGVyaW9kLiAgUGxlYXNlIGZvbGxvdyB0aGlzIGNvbnZlbnRpb24K LWZvciB0aGUgc2FrZSBvZiBjb25zaXN0ZW5jeS4KKyAgIlNpZ25hbCBhIHVzZXIgZXJyb3IsIG1h a2luZyBhIG1lc3NhZ2UgYnkgcGFzc2luZyBBUkdTIHRvIGBmb3JtYXQtbWVzc2FnZScuCiBUaGlz IGlzIGp1c3QgbGlrZSBgZXJyb3InIGV4Y2VwdCB0aGF0IGB1c2VyLWVycm9yJ3MgYXJlIGV4cGVj dGVkIHRvIGJlIHRoZQogcmVzdWx0IG9mIGFuIGluY29ycmVjdCBtYW5pcHVsYXRpb24gb24gdGhl IHBhcnQgb2YgdGhlIHVzZXIsIHJhdGhlciB0aGFuIHRoZQogcmVzdWx0IG9mIGFuIGFjdHVhbCBw cm9ibGVtLgorSW4gRW1hY3MsIHRoZSBjb252ZW50aW9uIGlzIHRoYXQgZXJyb3IgbWVzc2FnZXMg c3RhcnQgd2l0aCBhIGNhcGl0YWwKK2xldHRlciBidXQgKmRvIG5vdCogZW5kIHdpdGggYSBwZXJp b2QuICBQbGVhc2UgZm9sbG93IHRoaXMgY29udmVudGlvbgorZm9yIHRoZSBzYWtlIG9mIGNvbnNp c3RlbmN5LgorSW4gY29udHJhc3Qgd2l0aCBvdGhlciBlcnJvcnMsIHVzZXIgZXJyb3JzIG5vcm1h bGx5IGRvIG5vdCBjYXVzZQorZW50cnkgdG8gdGhlIGRlYnVnZ2VyLCBldmVuIHdoZW4gYGRlYnVn LW9uLWVycm9yJyBpcyBub24tbmlsLgorVGhpcyBjYW4gYmUgb3ZlcnJpZGRlbiBieSBgZGVidWct aWdub3JlZC1lcnJvcnMnLgogCiBOb3RlOiAodXNlci1lcnJvciBcIiVzXCIgVkFMVUUpIG1ha2Vz IHRoZSBtZXNzYWdlIFZBTFVFIHdpdGhvdXQKIGludGVycHJldGluZyBmb3JtYXQgY2hhcmFjdGVy cyBsaWtlIGAlJywgYFxcPWAnLCBhbmQgYFxcPScnLiIKLS0gCjIuMTEuMAoK --000000000000797746058b46ad10--