GNU bug report logs - #65195
13.2.1; (La)TeX-fold-math-spec-list have the wrong custom type

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 65195 in the body.
You can then email your comments to 65195 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Tony Zorman <tonyzorman <at> mailbox.org>
To: bug-auctex <at> gnu.org
Subject: 13.2.1; (La)TeX-fold-math-spec-list have the wrong custom type
Date: Thu, 10 Aug 2023 06:46:04 +0200

Hi,

the custom type for `(La)TeX-fold-math-spec-list' is

  (repeat (group (choice (string :tag "Display String")
                         (integer :tag "Number of argument" :value 1))
                 (repeat :tag "Math Macros" (string))))

However, the following is a perfectly valid definition

  (setopt TeX-fold-math-spec-list
          `((,(lambda (word) word) ("mathbf"))))

(the code to handle functions is in `TeX-fold-hide-item').

Currently, the `setopt' macro throws some warning, because a function is
not part of the type (presumably this was forgotten). I propose to have
a type closer to what `TeX-fold-macro-spec-list' has:

  (repeat (group (choice (string :tag "Display String")
                         (integer :tag "Number of argument" :value 1)
                         (function :tag "Function to execute"))
                 (repeat :tag "Math Macros" (string))))

The relevant functions called, like `TeX-fold-make-overlay' would also
have to have their documentation adjusted.

I can prepare a small patch, or someone can commit this directly,
whatever people feel like is easier.

Thanks,
   Tony

--- I don't think this is very relevant, but I'll leave what `M-x
--- TeX-submit-bug-report' generated here.

Emacs  : GNU Emacs 30.0.50 (build 1, x86_64-pc-linux-musl, cairo version 1.16.0) of 2023-08-03
Package: 13.2.1

current state:
==============
(setq
 AUCTeX-date "2023-07-20"
 window-system 'x
 LaTeX-version "2e"
 TeX-style-path '("~/.emacs.d/auctex" "/home/slot/.config/emacs/elpa/auctex-13.2.1/style"
                  "/home/slot/.config/emacs/auctex/auto"
                  "/home/slot/.config/emacs/auctex/style" "auto" "style")
 TeX-auto-save t
 TeX-parse-self t
 TeX-master t
 TeX-command-list '(("TeX"
                     "%(PDF)%(tex) %(file-line-error) %`%(extraopts) %S%(PDFout)%(mode)%' %(output-dir) %t"
                     TeX-run-TeX nil (plain-tex-mode ams-tex-mode texinfo-mode) :help
                     "Run plain TeX")
                    ("LaTeX" "%`%l%(mode)%' %T" TeX-run-TeX nil (latex-mode doctex-mode)
                     :help "Run LaTeX")
                    ("Makeinfo" "makeinfo %(extraopts) %(o-dir) %t" TeX-run-compile nil
                     (texinfo-mode) :help "Run Makeinfo with Info output")
                    ("Makeinfo HTML" "makeinfo %(extraopts) %(o-dir) --html %t"
                     TeX-run-compile nil (texinfo-mode) :help
                     "Run Makeinfo with HTML output")
                    ("AmSTeX" "amstex %(PDFout) %`%(extraopts) %S%(mode)%' %(output-dir) %t"
                     TeX-run-TeX nil (ams-tex-mode) :help "Run AMSTeX")
                    ("ConTeXt" "%(cntxcom) --once --texutil %(extraopts) %(execopts)%t"
                     TeX-run-TeX nil (context-mode) :help "Run ConTeXt once")
                    ("ConTeXt Full" "%(cntxcom) %(extraopts) %(execopts)%t" TeX-run-TeX nil
                     (context-mode) :help "Run ConTeXt until completion")
                    ("BibTeX" "bibtex %(O?aux)" TeX-run-BibTeX nil
                     (plain-tex-mode latex-mode doctex-mode ams-tex-mode texinfo-mode
                      context-mode)
                     :help "Run BibTeX")
                    ("Biber" "biber %(output-dir) %s" TeX-run-Biber nil
                     (plain-tex-mode latex-mode doctex-mode ams-tex-mode texinfo-mode) :help
                     "Run Biber")
                    ("Texindex" "texindex %s.??" TeX-run-command nil (texinfo-mode) :help
                     "Run Texindex")
                    ("Texi2dvi" "%(PDF)texi2dvi %t" TeX-run-command nil (texinfo-mode) :help
                     "Run Texi2dvi or Texi2pdf")
                    ("View" "%V" TeX-run-discard-or-function t t :help "Run Viewer")
                    ("Print" "%p" TeX-run-command t t :help "Print the file")
                    ("Queue" "%q" TeX-run-background nil t :help "View the printer queue"
                     :visible TeX-queue-command)
                    ("File" "%(o?)dvips %d -o %f " TeX-run-dvips t
                     (plain-tex-mode latex-mode doctex-mode ams-tex-mode texinfo-mode) :help
                     "Generate PostScript file")
                    ("Dvips" "%(o?)dvips %d -o %f " TeX-run-dvips nil
                     (plain-tex-mode latex-mode doctex-mode ams-tex-mode texinfo-mode) :help
                     "Convert DVI file to PostScript")
                    ("Dvipdfmx" "dvipdfmx -o %(O?pdf) %d" TeX-run-dvipdfmx nil
                     (plain-tex-mode latex-mode doctex-mode ams-tex-mode texinfo-mode) :help
                     "Convert DVI file to PDF with dvipdfmx")
                    ("Ps2pdf" "ps2pdf %f %(O?pdf)" TeX-run-ps2pdf nil
                     (plain-tex-mode latex-mode doctex-mode ams-tex-mode texinfo-mode) :help
                     "Convert PostScript file to PDF")
                    ("Glossaries" "makeglossaries %(d-dir) %s" TeX-run-command nil
                     (plain-tex-mode latex-mode doctex-mode ams-tex-mode texinfo-mode) :help
                     "Run makeglossaries to create glossary file")
                    ("Index" "makeindex %(O?idx)" TeX-run-index nil
                     (plain-tex-mode latex-mode doctex-mode ams-tex-mode texinfo-mode) :help
                     "Run makeindex to create index file")
                    ("upMendex" "upmendex %(O?idx)" TeX-run-index t
                     (plain-tex-mode latex-mode doctex-mode ams-tex-mode texinfo-mode) :help
                     "Run upmendex to create index file")
                    ("Xindy" "texindy %s" TeX-run-command nil
                     (plain-tex-mode latex-mode doctex-mode ams-tex-mode texinfo-mode) :help
                     "Run xindy to create index file")
                    ("Check" "lacheck %s" TeX-run-compile nil (latex-mode) :help
                     "Check LaTeX file for correctness")
                    ("ChkTeX" "chktex -v6 %s" TeX-run-compile nil (latex-mode) :help
                     "Check LaTeX file for common mistakes")
                    ("Spell" "(TeX-ispell-document \"\")" TeX-run-function nil t :help
                     "Spell-check the document")
                    ("Clean" "TeX-clean" TeX-run-function nil t :help
                     "Delete generated intermediate files")
                    ("Clean All" "(TeX-clean t)" TeX-run-function nil t :help
                     "Delete generated intermediate and output files")
                    ("Other" "" TeX-run-command t t :help "Run an arbitrary command"))
 )

-- 
Tony Zorman | https://tony-zorman.com/

Message #8 received at 65195 <at> debbugs.gnu.org (full text, mbox):

From: Ikumi Keita <ikumi <at> ikumi.que.jp>
To: Tony Zorman <tonyzorman <at> mailbox.org>
Cc: 65195 <at> debbugs.gnu.org
Subject: Re: bug#65195: 13.2.1;
 (La)TeX-fold-math-spec-list have the wrong custom type
Date: Sat, 12 Aug 2023 14:10:30 +0900

Hi Tony,

>>>>> Tony Zorman via bug-auctex via Bug reporting list for AUCTeX <bug-auctex <at> gnu.org> writes:
> Hi,
> the custom type for `(La)TeX-fold-math-spec-list' is

>   (repeat (group (choice (string :tag "Display String")
>                          (integer :tag "Number of argument" :value 1))
>                  (repeat :tag "Math Macros" (string))))

> However, the following is a perfectly valid definition

>   (setopt TeX-fold-math-spec-list
>           `((,(lambda (word) word) ("mathbf"))))

> (the code to handle functions is in `TeX-fold-hide-item').

> Currently, the `setopt' macro throws some warning, because a function is
> not part of the type (presumably this was forgotten). I propose to have
> a type closer to what `TeX-fold-macro-spec-list' has:

>   (repeat (group (choice (string :tag "Display String")
>                          (integer :tag "Number of argument" :value 1)
>                          (function :tag "Function to execute"))
>                  (repeat :tag "Math Macros" (string))))

> The relevant functions called, like `TeX-fold-make-overlay' would also
> have to have their documentation adjusted.

Thanks for your report, I think it is actually a bug. I pushed the fix
to the git repo according to your proposal.

Regards,
Ikumi Keita
#StandWithUkraine #StopWarInUkraine

Message #13 received at 65195 <at> debbugs.gnu.org (full text, mbox):

From: Ikumi Keita <ikumi <at> ikumi.que.jp>
To: Tony Zorman <tonyzorman <at> mailbox.org>
Cc: 65195 <at> debbugs.gnu.org
Subject: Re: bug#65195: 13.2.1;
 (La)TeX-fold-math-spec-list have the wrong custom type
Date: Sat, 12 Aug 2023 15:05:30 +0900

Hi Tony,

>>>>> Tony Zorman <tonyzorman <at> mailbox.org> writes:
> I will note that the doc-string of `TeX-fold-make-overlay' might need to
> be adjusted as well; currently it states that

>> DISPLAY-STRING-SPEC is the original specification of the display
>> string in the variables `TeX-fold-macro-spec-list' or
>> `TeX-fold-env-spec-list' and may be a string or an integer.
>                                  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Oh, thanks. I fixed it as well.

Regards,
Ikumi Keita
#StandWithUkraine #StopWarInUkraine

Message #16 received at 65195 <at> debbugs.gnu.org (full text, mbox):

From: Tony Zorman <tonyzorman <at> mailbox.org>
To: Ikumi Keita <ikumi <at> ikumi.que.jp>
Cc: 65195 <at> debbugs.gnu.org
Subject: Re: bug#65195: 13.2.1; (La)TeX-fold-math-spec-list have the wrong
 custom type
Date: Sat, 12 Aug 2023 07:37:37 +0200

Hi Ikumi,

On Sat, Aug 12 2023 14:10, Ikumi Keita wrote:
> Thanks for your report, I think it is actually a bug. I pushed the fix
> to the git repo according to your proposal.

thank you!

I will note that the doc-string of `TeX-fold-make-overlay' might need to
be adjusted as well; currently it states that

  > DISPLAY-STRING-SPEC is the original specification of the display
  > string in the variables `TeX-fold-macro-spec-list' or
  > `TeX-fold-env-spec-list' and may be a string or an integer.
                                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

  Tony

-- 
Tony Zorman | https://tony-zorman.com/

Previous Next

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