From mboxrd@z Thu Jan  1 00:00:00 1970
Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail
From: Eli Zaretskii <eliz@gnu.org>
Newsgroups: gmane.emacs.devel
Subject: Re: doc improvements for bug-reference.el
Date: Sun, 27 Jun 2021 20:43:59 +0300
Message-ID: <83mtrbp5i8.fsf@gnu.org>
References: <86sg14xm6u.fsf@stephe-leake.org> <83v95zq1jj.fsf@gnu.org>
 <86o8brxqoo.fsf@stephe-leake.org>
Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214";
	logging-data="21659"; mail-complaints-to="usenet@ciao.gmane.io"
Cc: emacs-devel@gnu.org
To: Stephen Leake <stephen_leake@stephe-leake.org>
Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Sun Jun 27 19:44:49 2021
Return-path: <emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org>
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 <emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org>)
	id 1lxYpt-0005P8-4y
	for ged-emacs-devel@m.gmane-mx.org; Sun, 27 Jun 2021 19:44:49 +0200
Original-Received: from localhost ([::1]:56776 helo=lists1p.gnu.org)
	by lists.gnu.org with esmtp (Exim 4.90_1)
	(envelope-from <emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org>)
	id 1lxYpq-0006ST-VO
	for ged-emacs-devel@m.gmane-mx.org; Sun, 27 Jun 2021 13:44:47 -0400
Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:42516)
 by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.90_1) (envelope-from <eliz@gnu.org>) id 1lxYpB-0005nE-BA
 for emacs-devel@gnu.org; Sun, 27 Jun 2021 13:44:05 -0400
Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:39380)
 by eggs.gnu.org with esmtp (Exim 4.90_1)
 (envelope-from <eliz@gnu.org>)
 id 1lxYpA-00072T-Ew; Sun, 27 Jun 2021 13:44:04 -0400
Original-Received: from 84.94.185.95.cable.012.net.il ([84.94.185.95]:3426
 helo=home-c4e4a596f7)
 by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.90_1) (envelope-from <eliz@gnu.org>)
 id 1lxYpA-0006Sx-1c; Sun, 27 Jun 2021 13:44:04 -0400
In-Reply-To: <86o8brxqoo.fsf@stephe-leake.org> (message from Stephen Leake on
 Sun, 27 Jun 2021 08:39:19 -0700)
X-BeenThere: emacs-devel@gnu.org
X-Mailman-Version: 2.1.23
Precedence: list
List-Id: "Emacs development discussions." <emacs-devel.gnu.org>
List-Unsubscribe: <https://lists.gnu.org/mailman/options/emacs-devel>,
 <mailto:emacs-devel-request@gnu.org?subject=unsubscribe>
List-Archive: <https://lists.gnu.org/archive/html/emacs-devel>
List-Post: <mailto:emacs-devel@gnu.org>
List-Help: <mailto:emacs-devel-request@gnu.org?subject=help>
List-Subscribe: <https://lists.gnu.org/mailman/listinfo/emacs-devel>,
 <mailto:emacs-devel-request@gnu.org?subject=subscribe>
Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org
Original-Sender: "Emacs-devel"
 <emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org>
Xref: news.gmane.io gmane.emacs.devel:271056
Archived-At: <http://permalink.gmane.org/gmane.emacs.devel/271056>

> From: Stephen Leake <stephen_leake@stephe-leake.org>
> Cc: emacs-devel@gnu.org
> Date: Sun, 27 Jun 2021 08:39:19 -0700
> 
> >> +  (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.

Even if the code is called from a Lisp program?

> maintaining.texi does not mention the default key-binding; perhaps it
> should?

If they are important enough to document.

Thanks.