From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Stephen Leake Newsgroups: gmane.emacs.devel Subject: Re: doc improvements for bug-reference.el Date: Sun, 27 Jun 2021 08:39:19 -0700 Message-ID: <86o8brxqoo.fsf@stephe-leake.org> References: <86sg14xm6u.fsf@stephe-leake.org> <83v95zq1jj.fsf@gnu.org> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="11162"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.0.50 (windows-nt) Cc: emacs-devel@gnu.org To: Eli Zaretskii Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Sun Jun 27 17:40:15 2021 Return-path: Envelope-to: ged-emacs-devel@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1lxWtL-0002iV-09 for ged-emacs-devel@m.gmane-mx.org; Sun, 27 Jun 2021 17:40:15 +0200 Original-Received: from localhost ([::1]:44346 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lxWtK-0005OA-0N for ged-emacs-devel@m.gmane-mx.org; Sun, 27 Jun 2021 11:40:14 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:57412) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lxWsX-0004An-8o for emacs-devel@gnu.org; Sun, 27 Jun 2021 11:39:25 -0400 Original-Received: from gateway32.websitewelcome.com ([192.185.145.184]:39394) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lxWsV-0004EO-CM for emacs-devel@gnu.org; Sun, 27 Jun 2021 11:39:24 -0400 Original-Received: from cm12.websitewelcome.com (cm12.websitewelcome.com [100.42.49.8]) by gateway32.websitewelcome.com (Postfix) with ESMTP id B3D001133CF for ; Sun, 27 Jun 2021 10:39:21 -0500 (CDT) Original-Received: from host2007.hostmonster.com ([67.20.76.71]) by cmsmtp with SMTP id xWsTlkV5tjIaZxWsTl918b; Sun, 27 Jun 2021 10:39:21 -0500 X-Authority-Reason: nr=8 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=stephe-leake.org; s=default; h=Content-Type:MIME-Version:Message-ID: In-Reply-To:Date:References:Subject:Cc:To:From:Sender:Reply-To: Content-Transfer-Encoding:Content-ID:Content-Description:Resent-Date: Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Id: List-Help:List-Unsubscribe:List-Subscribe:List-Post:List-Owner:List-Archive; bh=VpE8MEpGl/cUTTfXxTxEEZTIsZz9Uzof/l4+WTi7OrE=; b=kmdVpKoS8wEWGmmt83W0GIsRFD 8JmzzG9qyudylHhXlIVjbnnI71TiPe7PE9E3vw6RFfR46NziRDCesUJPTjffl+N7eNbz73RtpZNst 0RySfBBZ0CyMGLGUPOKNFt5zfTtyo5zcWzcvSurgNOWXcPTAcZ+iz/PbUD52p+H+dwugS3fQ56kDB bCZLfHo3jgIpc9xowLzonpX4XqzkPDnBFh3bCcXCURMgYfxlDybhJaVqFplNyJvTTacOTtT/Lrh1D 1VqF8REqjn9SaT0jq7CoAvwSj58JfWmwJooYYpjnq9cWFJamV7aLo74+Uc3FDTG2hH0qHDvGnsvvG WopudLyw==; Original-Received: from [76.77.182.20] (port=51479 helo=Takver4) by host2007.hostmonster.com with esmtpsa (TLS1.2) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.94.2) (envelope-from ) id 1lxWsT-000n0L-3n; Sun, 27 Jun 2021 09:39:21 -0600 In-Reply-To: <83v95zq1jj.fsf@gnu.org> (Eli Zaretskii's message of "Sun, 27 Jun 2021 09:12:00 +0300") X-AntiAbuse: This header was added to track abuse, please include it with any abuse report X-AntiAbuse: Primary Hostname - host2007.hostmonster.com X-AntiAbuse: Original Domain - gnu.org X-AntiAbuse: Originator/Caller UID/GID - [47 12] / [47 12] X-AntiAbuse: Sender Address Domain - stephe-leake.org X-BWhitelist: no X-Source-IP: 76.77.182.20 X-Source-L: No X-Exim-ID: 1lxWsT-000n0L-3n X-Source-Sender: (Takver4) [76.77.182.20]:51479 X-Source-Auth: stephen_leake@stephe-leake.org X-Email-Count: 2 X-Source-Cap: c3RlcGhlbGU7c3RlcGhlbGU7aG9zdDIwMDcuaG9zdG1vbnN0ZXIuY29t X-Local-Domain: yes Received-SPF: neutral client-ip=192.185.145.184; envelope-from=stephen_leake@stephe-leake.org; helo=gateway32.websitewelcome.com X-Spam_score_int: -8 X-Spam_score: -0.9 X-Spam_bar: / X-Spam_report: (-0.9 / 5.0 requ) BAYES_00=-1.9, DKIM_INVALID=0.1, DKIM_SIGNED=0.1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_PASS=-0.001, SPF_NEUTRAL=0.779 autolearn=no autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.io gmane.emacs.devel:271054 Archived-At: Eli Zaretskii writes: >> From: Stephen Leake >> Date: Sat, 26 Jun 2021 16:04:09 -0700 >> >> I just customized bug-reference-mode for emacs debbugs. I had to read >> the code to figure out what to set, so I have some suggestions for >> improving the documentation; see attached patch. > > Thanks. > >> -;; the other operates only on comments and strings. >> +;; the other operates only on comments and strings. By default, the >> +;; URL link is followed by invoking C-c RET or mouse-2. > > Two spaces between sentences, please. > >> + (when (null bug-reference-url-format) >> + (user-error >> + "You must customize `bug-reference-url-format', then restart >> bug-reference-mode.")) > > Is this really a user-error? >From the doc string of user-error: is intended to report errors on the part of the user, rather than errors in the code itself I think that fits here; the user must take some action to make this work; it's not a bug to be reported. > Also, does anything need to be improved in maintaining.texi? I was not aware of that; I'll add a reference to it in bug-reference.el, and change the user-error message to refer to it instead. maintaining.texi does not mention the default key-binding; perhaps it should? I'm not sure what the emacs manual convention on this is. Otherwise it looks ok. Also, I'll try to create a function for bug-reference-auto-setup-functions to handle references in the emacs-devel mailing list. -- -- Stephe