GNU bug report logs - #74409
30.0.92; customize buffer for bibtex-biblatex-entry-alist also shows unformatted variable value

Previous Next

Package: emacs;

Reported by: Roland Winkler <winkler <at> gnu.org>

Date: Sun, 17 Nov 2024 22:45:02 UTC

Severity: normal

Found in version 30.0.92

Done: Roland Winkler <winkler <at> gnu.org>

Bug is archived. No further changes may be made.

Full log


View this message in rfc822 format

From: Eli Zaretskii <eliz <at> gnu.org>
To: Mauro Aranda <maurooaranda <at> gmail.com>
Cc: 74409 <at> debbugs.gnu.org, winkler <at> gnu.org
Subject: bug#74409: 30.0.92; customize buffer for bibtex-biblatex-entry-alist also shows unformatted variable value
Date: Sun, 12 Jan 2025 07:40:45 +0200
> Date: Sat, 11 Jan 2025 17:30:15 -0300
> Cc: Eli Zaretskii <eliz <at> gnu.org>, 74409 <at> debbugs.gnu.org
> From: Mauro Aranda <maurooaranda <at> gmail.com>
> 
> Roland Winkler <winkler <at> gnu.org> writes:
> 
>  >> Docs could be improved here.  Not having a :tag, is almost never a
>  >> good idea.  This would be specific to the section Defining New Types.
>  >
>  > I am keeping this bug open.  Can you possibly provide a documentation
>  > patch regarding the :tag keyword for new types?  Thanks.
> 
> Here's an attempt.  Please review.

Thanks, a couple of typo corrections below.

>  @item :tag @var{tag}
>  Use @var{tag} (a string) as the tag for the value (or part of the value)
> -that corresponds to this type.
> +that corresponds to this type.  It's important to provide an informative
> +tag for the customization interface, specially if you're using the
                                        ^^^^^^^^^
"especially"

> +@code{restricted-sexp} type or if you're defining a new type.
> +@xref{Defining New Types}.
>  
>  @item :doc @var{doc}
>  @kindex doc <at> r{, customization keyword}
> @@ -1349,10 +1352,15 @@ Defining New Types
>  being either a string, or a cons-cell whose car and cdr are themselves
>  both @code{binary-tree-of-string}.  Note the reference to the widget
>  type we are currently in the process of defining.  The @code{:tag}
> -attribute is a string to name the widget in the user interface, and the
> -@code{:offset} argument is there to ensure that child nodes are
> -indented four spaces relative to the parent node, making the tree
> -structure apparent in the customization buffer.
> +is another important keyword argument because we are using the
> +@code{lazy} widget for our new widget.  By default, the @code{lazy}
> +widget doesn't have a tag, and in its abscence the customization buffer
                                         ^^^^^^^^
"absence"




This bug report was last modified 128 days ago.

Previous Next


GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.