Re: doc improvements for bug-reference.el

[Eli Zaretskii <eliz@gnu.org>]

> 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.