texinfo-commits
[Top][All Lists]
Advanced

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

branch master updated: * tp/Texinfo/Indices.pm, tp/Texinfo/Structuring.p


From: Patrice Dumas
Subject: branch master updated: * tp/Texinfo/Indices.pm, tp/Texinfo/Structuring.pm: update POD documentation.
Date: Thu, 11 Apr 2024 17:48:53 -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 1f1916902c * tp/Texinfo/Indices.pm, tp/Texinfo/Structuring.pm: update 
POD documentation.
1f1916902c is described below

commit 1f1916902c6231244bc6937eee34e7ec308eb513
Author: Patrice Dumas <pertusus@free.fr>
AuthorDate: Thu Apr 11 23:48:45 2024 +0200

    * tp/Texinfo/Indices.pm, tp/Texinfo/Structuring.pm: update POD
    documentation.
---
 ChangeLog                 |  5 +++++
 tp/Texinfo/Indices.pm     |  2 +-
 tp/Texinfo/Structuring.pm | 13 ++++++++++---
 3 files changed, 16 insertions(+), 4 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 123c99b40c..4631cc8176 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2024-04-11  Patrice Dumas  <pertusus@free.fr>
+
+       * tp/Texinfo/Indices.pm, tp/Texinfo/Structuring.pm: update POD
+       documentation.
+
 2024-04-11  Patrice Dumas  <pertusus@free.fr>
 
        * tp/t/test_utils.pl: change a TODO to a NOTE.
diff --git a/tp/Texinfo/Indices.pm b/tp/Texinfo/Indices.pm
index 3824a2afda..69b4e8c1b5 100644
--- a/tp/Texinfo/Indices.pm
+++ b/tp/Texinfo/Indices.pm
@@ -830,7 +830,7 @@ information, which means an object implementing the 
C<get_conf> method, a
 converter (L<Texinfo::Convert::Converter/Getting and setting customization
 variables>) or a document L<Texinfo::Document/Getting customization options
 values registered in document>) as I<$customization_information> argument.  If
-the C<$registrar> argument is not set, the object used to get customization
+the I<$registrar> argument is not set, the object used to get customization
 information is assumed to be a converter, and the error reporting uses
 converters error messages reporting functions
 (L<Texinfo::Convert::Converter/Registering error and warning messages>).
diff --git a/tp/Texinfo/Structuring.pm b/tp/Texinfo/Structuring.pm
index 161a48d031..aa7ef6ed88 100644
--- a/tp/Texinfo/Structuring.pm
+++ b/tp/Texinfo/Structuring.pm
@@ -1565,6 +1565,7 @@ sub new_master_menu($$$$;$)
 }
 
 # TODO document
+# $SELF should be a converter.
 sub new_complete_menu_master_menu($$$)
 {
   my $self = shift;
@@ -2476,13 +2477,19 @@ I<$customization_information>, if defined, should hold 
information
 needed for translations.  Translations are only needed when generating the
 top node menu.
 
-=item $detailmenu = new_master_menu($customization_information, 
$identifier_target, $menus)
+=item $detailmenu = new_master_menu($customization_information, $registrar, 
$identifier_target, $menus)
 X<C<new_master_menu>>
 
 Returns a detailmenu tree element formatted as a master node.
 I<$menus> is an array reference containing the regular menus of the Top node.
-I<$customization_information>, if defined, should hold information
-needed for translations.
+I<$customization_information> should hold information needed for translations
+and error reporting.
+
+The I<$registrar> argument can be set to a L<Texinfo::Report> object.
+If the I<$registrar> argument is not set, I<$customization_information> is
+assumed to be a converter, and error reporting uses converters error
+messages reporting functions (L<Texinfo::Convert::Converter/Registering error
+and warning messages>).
 
 =item $entry = new_node_menu_entry($node, $use_sections)
 X<C<new_node_menu_entry>>



reply via email to

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