branch master updated: Changes in TODO/FIXME comments

[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 8af8942747 Changes in TODO/FIXME comments
8af8942747 is described below

commit 8af89427470844cfca2987b7c276a15085f149b6
Author: Patrice Dumas <pertusus@free.fr>
AuthorDate: Sat Jul 29 22:54:08 2023 +0200

    Changes in TODO/FIXME comments
---
 tp/Texinfo/Convert/Converter.pm   | 22 +++++++++++++---------
 tp/Texinfo/Convert/HTML.pm        |  2 +-
 tp/Texinfo/Convert/TexinfoSXML.pm |  2 +-
 tp/Texinfo/ParserNonXS.pm         |  2 +-
 4 files changed, 16 insertions(+), 12 deletions(-)

diff --git a/tp/Texinfo/Convert/Converter.pm b/tp/Texinfo/Convert/Converter.pm
index c514beba2b..6b489d6fb2 100644
--- a/tp/Texinfo/Convert/Converter.pm
+++ b/tp/Texinfo/Convert/Converter.pm
@@ -407,14 +407,16 @@ sub output($$)
         $output .= $self->write_or_return($tree_unit_text, $fh);
       }
     } else {
-      # FIXME this is in general better to use convert() for instance
-      # to have the converter output footnotes as it cannot do is as
-      # part of tree units formatting.  However, this breaks the promise
-      # that only convert_tree is used in generic Converter code.
-      # REMARK that right now, this code is never called, as
+      # REMARK right now, this code is never called, as
       # Texinfo::Structuring::split_by_node or split_by_page always return
       # an array containing at least one unit.  But this was not the case
       # in the past and could change again in the future.
+      #
+      # FIXME this is in general better to use convert(), for instance
+      # to have the converter output footnotes when it is not done
+      # as part of tree units formatting (th case here).
+      # However, this breaks the promise that only convert_tree is used
+      # in generic Converter code.
       $output .= $self->write_or_return($self->convert($root), $fh);
     }
     # NOTE do not close STDOUT now to avoid a perl warning.
@@ -1738,11 +1740,13 @@ sub xml_accent($$$;$$$)
     }
   }
 
-  # should never happen, there are diacritics for every accent command
-  return $text . '&lt;' if ($accent eq 'v');
-  # FIXME it is not possible to call xml_protect_text since what is in $text
+  # REMARK this code should never be run as there are diacritics for every
+  # accent command.
+  #
+  # TODO it is not possible to call xml_protect_text since what is in $text
   # may already be xml.  But this means that each time ascii_accent changes
-  # it should be changed here too.
+  # it should be changed here too ii ascii_accent returns invalid xml.
+  return $text . '&lt;' if ($accent eq 'v');
   return Texinfo::Convert::Text::ascii_accent($text, $command);
 }
 
diff --git a/tp/Texinfo/Convert/HTML.pm b/tp/Texinfo/Convert/HTML.pm
index 81e975fa37..06280a847a 100644
--- a/tp/Texinfo/Convert/HTML.pm
+++ b/tp/Texinfo/Convert/HTML.pm
@@ -5685,7 +5685,7 @@ sub _convert_printindex_command($$$$)
           }
           $entry = '<code>' .$entry .'</code>' if ($in_code);
           $delimiter = $self->get_conf('INDEX_ENTRY_COLON');
-          # TODO add the information that it is associated with see also?
+          # TODO add the information that the entry is associated with see 
also?
           $entry_class = "$cmdname-index-entry";
           $section_class = "$cmdname-index-see-also";
         }
diff --git a/tp/Texinfo/Convert/TexinfoSXML.pm 
b/tp/Texinfo/Convert/TexinfoSXML.pm
index 962366d158..3b3b063780 100644
--- a/tp/Texinfo/Convert/TexinfoSXML.pm
+++ b/tp/Texinfo/Convert/TexinfoSXML.pm
@@ -52,7 +52,7 @@ sub converter_defaults($$)
   return %defaults;
 }
 
-# TODO protect foormfeeds, end of lines and other special spaces as in 
TexinfoXML?
+# TODO protect formfeeds, end of lines and other special spaces as in 
TexinfoXML?
 sub txi_markup_protect_text($$)
 {
   my $self = shift;
diff --git a/tp/Texinfo/ParserNonXS.pm b/tp/Texinfo/ParserNonXS.pm
index 91da54a455..675bec5e72 100644
--- a/tp/Texinfo/ParserNonXS.pm
+++ b/tp/Texinfo/ParserNonXS.pm
@@ -5415,7 +5415,7 @@ sub _handle_line_command($$$$$$)
         die;
       } else {
         # TODO do we want to error out if there is a root command in
-        # Texinfo fragment processed with parse_texi_text (and therefore
+        # Texinfo fragment processed with parse_texi_line (and therefore
         # here in root_line)?
         # $self->_line_error(sprintf(__(
         #  "\@%s should not appear in Texinfo parsed as a short fragment"),