texinfo-commits
[Top][All Lists]
Advanced

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

[6113] Report.pm module documentation


From: Gavin D. Smith
Subject: [6113] Report.pm module documentation
Date: Tue, 10 Feb 2015 17:30:54 +0000

Revision: 6113
          http://svn.sv.gnu.org/viewvc/?view=rev&root=texinfo&revision=6113
Author:   gavin
Date:     2015-02-10 17:30:51 +0000 (Tue, 10 Feb 2015)
Log Message:
-----------
Report.pm module documentation

Modified Paths:
--------------
    trunk/ChangeLog
    trunk/tp/Texinfo/Report.pm

Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog     2015-02-10 10:00:17 UTC (rev 6112)
+++ trunk/ChangeLog     2015-02-10 17:30:51 UTC (rev 6113)
@@ -1,3 +1,8 @@
+2015-02-10  Gavin Smith  <address@hidden>
+
+       * tp/Texinfo/Report.pm (Module documentation section): Minor 
+       tweaks to grammar.
+
 2015-02-09  Karl Berry  <address@hidden>
 
        * doc/refcard/txicmdcheck: check @findex entries in texinfo.texi too.

Modified: trunk/tp/Texinfo/Report.pm
===================================================================
--- trunk/tp/Texinfo/Report.pm  2015-02-10 10:00:17 UTC (rev 6112)
+++ trunk/tp/Texinfo/Report.pm  2015-02-10 17:30:51 UTC (rev 6113)
@@ -446,18 +446,18 @@
 
 =head1 DESCRIPTION
 
-The Texinfo::Report module helps with string translations and errors 
-handling.  It is used by Texinfo modules, Texinfo::Parser and 
+The Texinfo::Report module helps with string translations and error 
+handling.  It is used by the Texinfo modules Texinfo::Parser and 
 Texinfo::Convert::Converter.  To use this module, the usual way is
-to inherit Texinfo::Report methods and initialize Texinfo::Report
-variables for a I<$converter> object, by calling 
+to inherit Texinfo::Report methods and initialize the Texinfo::Report
+variables for a I<$converter> object. This is done by calling 
 C<Texinfo::Report::new()> on the I<$converter> object.  This is done by 
 Texinfo::Convert::Converter, for instance, so every module that inherits
 Texinfo::Convert::Converter can automatically use the Texinfo::Report
-methods in an object oriented way.
+methods in an object-oriented way.
 
-Besides the C<new> method, C<gdt> is used for strings translations, 
-C<errors> to report errors and the other methods to store errors
+Besides the C<new> method, C<gdt> is used for string translations, 
+C<errors> for reporting errors, and the other methods to store errors
 (and warnings).
 
 =head1 METHODS
@@ -482,13 +482,13 @@
 hash reference specifying some 
 substitution to be done after the translation.  The key of 
 the I<$replaced_substrings> hash reference identifies what is to 
-be substituted, the value is some string, texinfo tree or array content 
+be substituted, and the value is some string, texinfo tree or array content 
 that is substituted in the resulting texinfo tree.
 In the string to be translated word in brace matching keys of 
 I<$replaced_substrings> are replaced.
 
 I<$mode> is an optional string which may modify how the function
-behave.  The possible values are
+behaves.  The possible values are
 
 =over 
 
@@ -520,13 +520,13 @@
 C<< $converter->{'encoding_name'} >>, C<< $converter->{'perl_encoding'} >>
 and C<< $converter->get_conf('documentlanguage') >> are used.
 
-C<gdt> use a gettext-like infrastructure to retrieve the 
+C<gdt> uses a gettext-like infrastructure to retrieve the 
 translated strings, using the I<texinfo_document> domain.
 
 =back
 
 The errors collected are available through the C<errors> method, the other
-methods allow to register errors and warnings.
+methods allow registering errors and warnings.
 
 =over
 




reply via email to

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