texinfo-commits
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

branch master updated: * doc/texi2any_api.texi (Simple Navigation Panel


From: Patrice Dumas
Subject: branch master updated: * doc/texi2any_api.texi (Simple Navigation Panel Customization): comment out documentation of buttons specification that is not used in code nor tests.
Date: Wed, 01 May 2024 15:34:19 -0400

This is an automated email from the git hooks/post-receive script.

pertusus pushed a commit to branch master
in repository texinfo.

The following commit(s) were added to refs/heads/master by this push:
     new 9acd2c04c1 * doc/texi2any_api.texi (Simple Navigation Panel 
Customization): comment out documentation of buttons specification that is not 
used in code nor tests.
9acd2c04c1 is described below

commit 9acd2c04c1d39c25da94cb63784079c03ab9454a
Author: Patrice Dumas <pertusus@free.fr>
AuthorDate: Wed May 1 21:34:13 2024 +0200

    * doc/texi2any_api.texi (Simple Navigation Panel Customization):
    comment out documentation of buttons specification that is not used in
    code nor tests.
---
 ChangeLog                  | 6 ++++++
 doc/texi2any_api.texi      | 5 +++++
 tp/Texinfo/Convert/HTML.pm | 2 ++
 3 files changed, 13 insertions(+)

diff --git a/ChangeLog b/ChangeLog
index e1d7a75857..dffea242a9 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2024-05-01  Patrice Dumas  <pertusus@free.fr>
+
+       * doc/texi2any_api.texi (Simple Navigation Panel Customization):
+       comment out documentation of buttons specification that is not used in 
+       code nor tests.
+
 2024-05-01  Patrice Dumas  <pertusus@free.fr>
 
        Remove skipped test result.
diff --git a/doc/texi2any_api.texi b/doc/texi2any_api.texi
index 027db92b6d..cba5be3288 100644
--- a/doc/texi2any_api.texi
+++ b/doc/texi2any_api.texi
@@ -1212,6 +1212,10 @@ The functions is called with two arguments, the 
converter object and the
 output unit direction and should return two scalars, the link href and text and
 a boolean set if a delimiter is needed after that button.
 
+@c This buttons specification is not used anywhere in code nor
+@c tests, it is certainly not worth maintaining in the long run.
+@c Do not document
+@ignore
 @item text string
 The text string is interpreted as an output unit direction information type
 and the corresponding text is used for the link.
@@ -1225,6 +1229,7 @@ For example, if the button array item is
 @noindent
 Then the button will be a link to the next section with text
 based on the name of the node associated with the next section output unit.
+@end ignore
 
 @end table
 
diff --git a/tp/Texinfo/Convert/HTML.pm b/tp/Texinfo/Convert/HTML.pm
index 092928ee59..acda940e3b 100644
--- a/tp/Texinfo/Convert/HTML.pm
+++ b/tp/Texinfo/Convert/HTML.pm
@@ -4386,6 +4386,8 @@ sub _default_format_button($$;$)
         $active = $self->from_element_direction($direction, $text,
                                                 undef, undef, $source_command);
       } else {
+        # NOTE This buttons specification is not used anywhere in code nor
+        # tests, it is certainly not worth maintaining in the long run.
         my $href = $self->from_element_direction($direction, 'href',
                                                  undef, undef, 
$source_command);
         my $text_formatted = $self->from_element_direction($direction, $text);



reply via email to

[Prev in Thread] Current Thread [Next in Thread]