Commits

Shlomi Fish committed 95c55eb

Grammar fixes - close RT #89718.

Comments (0)

Files changed (2)

     - Add a unique_key method for namespace objects.
         - https://bitbucket.org/shlomif/perl-xml-libxml/pull-request/24/unique_key-method-for-namespace-objects/diff
         - Thanks to garfieldnate for the pull request.
+    - Grammar fixes in the documentation.
+        - https://rt.cpan.org/Ticket/Display.html?id=89718
+        - Thanks to Gregor Herrman and the Debian Team
 
 2.0106          Tue 17 Sep 19:08:31 IDT 2013
     - Import croak from "use Carp;" to fix a missing croak definition.
                             <funcsynopsisinfo>$gdomenode = XML::LibXML-&gt;export_GDOME( $node, $deep );</funcsynopsisinfo>
                         </funcsynopsis>
 
-                        <para>Allows to clone an XML::LibXML node into an XML::GDOME node.</para>
+                        <para>Allows one to clone an XML::LibXML node into an
+                            XML::GDOME node.</para>
+
                     </listitem>
                 </varlistentry>
             </variablelist>
                     </varlistentry>
                 </variablelist>
 
-                <para>By default XML::LibXML does not process XInclude tags within an XML Document (see options section below). XML::LibXML allows to post
-                process a document to expand XInclude tags.</para>
+                <para>By default XML::LibXML does not process XInclude tags
+                    within an XML Document (see options section below).
+                    XML::LibXML allows one to post-process a document to expand
+                    XInclude tags.</para>
 
                 <variablelist>
                     <varlistentry>
                         <funcsynopsisinfo>$doc-&gt;setEncoding($new_encoding);</funcsynopsisinfo>
                     </funcsynopsis>
 
-                    <para>This method allows to change the declaration of
+                    <para>This method allows one to change the declaration of
                       encoding in the XML declaration of the document.
 		      The value also affects the encoding in which the
 		      document is serialized to XML by $doc-&gt;toString().
 
                     <para>The more programmer friendly version of replaceData() :)</para>
 
-                    <para>Instead of giving offsets and length one can specify the exact string (<emphasis>$oldstring</emphasis>) to be replaced. Additionally
-                    the <emphasis>$all</emphasis> flag allows to replace all occurrences of <emphasis>$oldstring</emphasis>.</para>
+                    <para>Instead of giving offsets and length one can specify
+                        the exact string (<emphasis>$oldstring</emphasis>) to
+                        be replaced. Additionally the <emphasis>$all</emphasis>
+                        flag allows one to replace all occurrences of
+                        <emphasis>$oldstring</emphasis>.</para>
+
                 </listitem>
             </varlistentry>
 
                         <funcsynopsisinfo>$text-&gt;replaceDataRegEx( $search_cond, $replace_cond, $reflags );</funcsynopsisinfo>
                     </funcsynopsis>
 
-                    <para>This method replaces the node's data by a <function>simple</function> regular expression. Optional, this function allows to pass
-                    some flags that will be added as flag to the replace statement.</para>
+                    <para>This method replaces the node's data by a
+                        <function>simple</function> regular expression.
+                        Optional, this function allows one to pass some flags
+                        that will be added as flag to the replace
+                        statement.</para>
 
                     <para><emphasis>NOTE:</emphasis> This is a shortcut for</para>
 
 $pinode-&gt;setData( name=&gt;string_value [...] );</funcsynopsisinfo>
                     </funcsynopsis>
 
-                    <para>This method allows to change the content data of a PI. Additionally to the interface specified for DOM Level2, the method provides a
-                    named parameter interface to set the data. This parameter list is converted into a string before it is appended to the PI.</para>
+                    <para>This method allows one to change the content data of
+                        a PI. Additionally to the interface specified for DOM
+                        Level2, the method provides a named parameter
+                        interface to set the data. This parameter list is
+                        converted into a string before it is appended to the
+                        PI.</para>
                 </listitem>
             </varlistentry>
         </variablelist>
                 <sect3>
                     <title>Organisation of callback groups in XML::LibXML::InputCallback</title>
 
-                    <para>Callback groups are implemented as a stack (Array), each entry holds a reference to an array of the callbacks. For the libxml2
-                    library, the XML::LibXML::InputCallback callback implementation appears as one single callback group. The Perl implementation however allows
-                    to manage different callback stacks on a per libxml2-parser basis.</para>
+                    <para>Callback groups are implemented as a stack (Array),
+                        each entry holds a reference to an array of the
+                        callbacks. For the libxml2 library, the
+                        XML::LibXML::InputCallback callback implementation
+                        appears as one single callback group. The Perl
+                        implementation however allows one to manage different
+                        callback stacks on a per libxml2-parser basis.</para>
                 </sect3>
             </sect2>
 
                     <para>The constructor of XML::LibXML::RelaxNG may get called with either one of three parameters. The parameter tells the class from which
                     source it should generate a validation schema. It is important, that each schema only have a single source.</para>
 
-                    <para>The location parameter allows to parse a schema from the filesystem or a URL.</para>
+                <para>The location parameter allows one to parse a schema
+                    from the filesystem or a URL.</para>
 
                     <para>The string parameter will parse the schema from the given XML string.</para>
 
-                    <para>The DOM parameter allows to parse the schema from a pre-parsed <xref linkend="XML-LibXML-Document"/>.</para>
+                    <para>The DOM parameter allows one to parse the schema from a pre-parsed <xref linkend="XML-LibXML-Document"/>.</para>
 
                     <para>Note that the constructor will die() if the schema does not meed the constraints of the RelaxNG specification.</para>
                 </listitem>
                         <funcsynopsisinfo>eval { $rngschema-&gt;validate( $doc ); };</funcsynopsisinfo>
                     </funcsynopsis>
 
-                    <para>This function allows to validate a (parsed) document
-	            against the given RelaxNG schema. The argument of this function should be an XML::LibXML::Document object.
-	            If this function succeeds, it will return 0, otherwise
-                    it will die() and report the errors found. Because of this validate() should be always evaluated.</para>
+                    <para>This function allows one to validate a (parsed)
+                        document against the given RelaxNG schema. The argument
+                        of this function should be an XML::LibXML::Document
+                        object.  If this function succeeds, it will return 0,
+                        otherwise it will die() and report the errors found.
+                        Because of this validate() should be always
+                        evaluated.</para>
+
                 </listitem>
             </varlistentry>
         </variablelist>
                     <para>The constructor of XML::LibXML::Schema may get called with either one of two parameters. The parameter tells the class from which
                     source it should generate a validation schema. It is important, that each schema only have a single source.</para>
 
-                    <para>The location parameter allows to parse a schema from the filesystem or a URL.</para>
+                <para>The location parameter allows one to parse a schema
+                    from the filesystem or a URL.</para>
 
                     <para>The string parameter will parse the schema from the given XML string.</para>
 
                         <funcsynopsisinfo>eval { $xmlschema-&gt;validate( $doc ); };</funcsynopsisinfo>
                     </funcsynopsis>
 
-                    <para>This function allows to validate a (parsed) document against the given XML Schema.
-                     The argument of this function should be a <xref linkend="XML-LibXML-Document"/> object.
-	             If this function succeeds, it will return 0, otherwise it
-                    will die() and report the errors found. Because of this validate() should be always evaluated.</para>
+                    <para>This function allows one to validate a (parsed)
+                        document against the given XML Schema.  The argument of
+                        this function should be a <xref
+                            linkend="XML-LibXML-Document"/> object.  If this
+                        function succeeds, it will return 0, otherwise it will
+                        die() and report the errors found. Because of this
+                        validate() should be always evaluated.</para>
+
                 </listitem>
             </varlistentry>
         </variablelist>