branch master updated: Change in comments, fix a function prototype.

[Patrice Dumas]

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 41771fe63f Change in comments, fix a function prototype.
41771fe63f is described below

commit 41771fe63f1f60bbe0305b8b915932ca3ca29b1a
Author: Patrice Dumas <pertusus@free.fr>
AuthorDate: Mon Sep 12 11:54:41 2022 +0200

    Change in comments, fix a function prototype.
---
 tp/Texinfo/Common.pm            |  4 ++--
 tp/Texinfo/Convert/Converter.pm |  4 ++--
 tp/Texinfo/Convert/HTML.pm      | 13 +++++++------
 3 files changed, 11 insertions(+), 10 deletions(-)

diff --git a/tp/Texinfo/Common.pm b/tp/Texinfo/Common.pm
index 18c273373f..cc516c5763 100644
--- a/tp/Texinfo/Common.pm
+++ b/tp/Texinfo/Common.pm
@@ -268,8 +268,8 @@ our %default_converter_customization = (
   # is released, but it should be good to update from time to time
   # to avoid test results that are not valid against their reported DTD.
   'TEXINFO_DTD_VERSION'   => '6.8',  # this is not the value documented,
-                                     # but it is better for tests to have a
-                                     # value that never changes.
+                                     # but it is better for the tests to
+                                     # have a fix value.
                                      # The main program sets the
                                      # variable to the documented value.
 );
diff --git a/tp/Texinfo/Convert/Converter.pm b/tp/Texinfo/Convert/Converter.pm
index 4a5458036c..a2b3554fe9 100644
--- a/tp/Texinfo/Convert/Converter.pm
+++ b/tp/Texinfo/Convert/Converter.pm
@@ -68,8 +68,8 @@ my %defaults = (
 # but is available directly in the converter as a hash key.
 # FIXME separate the two types of information and check that those
 # items are not valid customization options?
-# NOTE converters for now do not add more, and, in general set only
-# output_format.  It would be good to keep it that way and add
+# NOTE converters for now do not add more, set converted_format, and,
+# rarely, output_format.  It would be good to keep it that way and add
 # customization options instead.
 my %common_converters_defaults = (
   'language_config_dirs' => undef,
diff --git a/tp/Texinfo/Convert/HTML.pm b/tp/Texinfo/Convert/HTML.pm
index 22d88bb347..6cf8227eba 100644
--- a/tp/Texinfo/Convert/HTML.pm
+++ b/tp/Texinfo/Convert/HTML.pm
@@ -910,7 +910,7 @@ sub command_contents_href($$$;$)
   return $href;
 }
 
-sub footnote_location_href($$;$$)
+sub footnote_location_href($$;$$$)
 {
   my $self = shift;
   my $command = shift;
@@ -928,9 +928,10 @@ sub footnote_location_href($$;$$)
   } elsif (defined($special_target)) {
     $target = $special_target->{'target'};
   }
-  # $target_filename node defined does not happen in the default footnote
-  # formatting functions, the file is always known as the footnote in the
-  # document appears before the footnote text formatting.  It is a good thing
+  # In the default footnote formatting functions, which calls
+  # footnote_location_href, the target file is always known as the
+  # footnote in the document appears before the footnote text formatting.
+  # $target_filename is therefore always defined.  It is a good thing
   # for the case of @footnote being formatted more than once (in multiple
   # @insertcopying for instance) as the file found just below may not be the
   # correct one in such a case.
@@ -7603,8 +7604,8 @@ sub _html_get_tree_root_element($$;$);
 # If $find_container is set, the element that holds the command output
 # is found, otherwise the element that holds the command is found.  This is
 # mostly relevant for footnote only.
-# If no known root element type is found, the returned root element is undef, 
and not
-# set to the element at the tree root
+# If no known root element type is found, the returned root element is undef,
+# and not set to the element at the tree root
 sub _html_get_tree_root_element($$;$)
 {
   my $self = shift;