Re: Math patches
| From: | jakub at vrana dot cz | Date: | Thu, 04 Dec 2003 17:21:11 +0000 |
| Subject: | Re: Math patches | ||
| References: | 1 2 | Groups: | php.doc |
| Request: | Send a blank email to phpdoc+get-969357190@lists.php.net to get a copy of this message | ||
> we don't use "number" but "int" or "float"
I come out from http://cz.php.net/manual/howto/chapter-conventions.html
where is written: "In prototypes, you can also use mixed (various
types), or number (either integer or float), or scalar (boolean,
integer, float or string)."
> perhaps I'm picky, but we (try to) always do :
> See also <function>func1</function>,
> <function>func1</function>,
> <function>func2</function>,
> [..]
> <function>func6</function> and
> <function>func7</function>.
Thanks for advice, I will use it in future. I didn't read it anywhere
and in other functions were <function>func1</function>,
<function>func2</function>
on one line too.
> considering the fact that the word "seed" was used twice in the sentence
> before, there's too much redundancy here. Maybe you can rephrase the
> whole paragraph or rename the parameter ? for example (my english sucks) :
My English sucks more, I call it Czenglish :-).
> Since <literal>PHP</literal> 4.2.0, the <parameter>foo</parameter> is
> optionnal and defaults to a random seed generated by
> <literal>PHP</literal> if ommited.
I tried to rewrite it without renaming the parameter.
> no news with your CVS account request ?
I'm patient as recommended on http://www.php.net/cvs-php ...
> Oh yes, something else : I'm not sure but if you name your patch
> "stg.txt" it will be displayed inline with your message in most mail
> reader (mine, btw ;)). It will be a little be handy to quick view it.
OK. I prefer real extension due to syntax highlighting. However I
understand that TXT is more handy for others.
Jakub Vrana
Index: abs.xml =================================================================== RCS file: /repository/phpdoc/en/reference/math/functions/abs.xml,v retrieving revision 1.4 diff -u -r1.4 abs.xml --- abs.xml 16 Jun 2003 18:31:33 -0000 1.4 +++ abs.xml 4 Dec 2003 17:15:57 -0000 @@ -9,7 +9,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>mixed</type><methodname>abs</methodname> + <type>number</type><methodname>abs</methodname> <methodparam><type>mixed</type><parameter>number</parameter></methodparam> </methodsynopsis> <para> Index: atan2.xml =================================================================== RCS file: /repository/phpdoc/en/reference/math/functions/atan2.xml,v retrieving revision 1.2 diff -u -r1.2 atan2.xml --- atan2.xml 17 Apr 2002 06:39:50 -0000 1.2 +++ atan2.xml 4 Dec 2003 17:15:57 -0000 @@ -4,7 +4,7 @@ <refentry id="function.atan2"> <refnamediv> <refname>atan2</refname> - <refpurpose>arc tangent of two variables</refpurpose> + <refpurpose>Arc tangent of two variables</refpurpose> </refnamediv> <refsect1> <title>Description</title> Index: bindec.xml =================================================================== RCS file: /repository/phpdoc/en/reference/math/functions/bindec.xml,v retrieving revision 1.3 diff -u -r1.3 bindec.xml --- bindec.xml 2 Jun 2002 11:56:51 -0000 1.3 +++ bindec.xml 4 Dec 2003 17:15:57 -0000 @@ -22,7 +22,10 @@ 31 bits of 1's or 2147483647 in decimal. </para> <para> - See also: <function>decbin</function>. + See also <function>decbin</function>, + <function>octdec</function>, + <function>hexdec</function> and + <function>base_convert</function>. </para> </refsect1> </refentry> Index: decbin.xml =================================================================== RCS file: /repository/phpdoc/en/reference/math/functions/decbin.xml,v retrieving revision 1.3 diff -u -r1.3 decbin.xml --- decbin.xml 2 Jun 2002 11:56:51 -0000 1.3 +++ decbin.xml 4 Dec 2003 17:15:57 -0000 @@ -18,7 +18,10 @@ 4294967295 in decimal resulting to a string of 32 1's. </para> <para> - See also: <function>bindec</function>. + See also <function>bindec</function>, + <function>decoct</function>, + <function>dechex</function> and + <function>base_convert</function>. </para> </refsect1> </refentry> Index: dechex.xml =================================================================== RCS file: /repository/phpdoc/en/reference/math/functions/dechex.xml,v retrieving revision 1.3 diff -u -r1.3 dechex.xml --- dechex.xml 3 Jun 2002 15:06:16 -0000 1.3 +++ dechex.xml 4 Dec 2003 17:15:57 -0000 @@ -18,7 +18,10 @@ be converted is 2147483647 in decimal resulting to "7fffffff". </para> <para> - See also <function>hexdec</function>. + See also <function>hexdec</function>, + <function>decbin</function>, + <function>decoct</function> and + <function>base_convert</function>. </para> </refsect1> </refentry> Index: decoct.xml =================================================================== RCS file: /repository/phpdoc/en/reference/math/functions/decoct.xml,v retrieving revision 1.3 diff -u -r1.3 decoct.xml --- decoct.xml 2 Jun 2002 11:56:51 -0000 1.3 +++ decoct.xml 4 Dec 2003 17:15:57 -0000 @@ -18,7 +18,10 @@ 2147483647 in decimal resulting to "17777777777". </para> <para> - See also <function>octdec</function>. + See also <function>octdec</function>, + <function>decbin</function>, + <function>dechex</function> and + <function>base_convert</function>. </para> </refsect1> </refentry> Index: hexdec.xml =================================================================== RCS file: /repository/phpdoc/en/reference/math/functions/hexdec.xml,v retrieving revision 1.4 diff -u -r1.4 hexdec.xml --- hexdec.xml 16 Jun 2003 18:31:33 -0000 1.4 +++ hexdec.xml 4 Dec 2003 17:15:57 -0000 @@ -41,7 +41,10 @@ </example> </para> <para> - See also <function>dechex</function>. + See also <function>dechex</function>, + <function>bindec</function>, + <function>octdec</function> and + <function>base_convert</function>. </para> </refsect1> </refentry> Index: log1p.xml =================================================================== RCS file: /repository/phpdoc/en/reference/math/functions/log1p.xml,v retrieving revision 1.2 diff -u -r1.2 log1p.xml --- log1p.xml 17 Apr 2002 06:39:53 -0000 1.2 +++ log1p.xml 4 Dec 2003 17:15:57 -0000 @@ -5,8 +5,8 @@ <refnamediv> <refname>log1p</refname> <refpurpose> - Returns log(1 + number), computed in a way that accurate even when the val -ue of number is close to zero + Returns log(1 + number), computed in a way that accurate even when + the value of number is close to zero </refpurpose> </refnamediv> <refsect1> Index: mt-srand.xml =================================================================== RCS file: /repository/phpdoc/en/reference/math/functions/mt-srand.xml,v retrieving revision 1.5 diff -u -r1.5 mt-srand.xml --- mt-srand.xml 30 May 2003 19:48:38 -0000 1.5 +++ mt-srand.xml 4 Dec 2003 17:15:57 -0000 @@ -10,11 +10,13 @@ <title>Description</title> <methodsynopsis> <type>void</type><methodname>mt_srand</methodname> - <methodparam><type>int</type><parameter>seed</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>seed</parameter></methodparam> </methodsynopsis> <para> Seeds the random number generator with <parameter>seed</parameter>. + Since PHP 4.2.0, the <parameter>seed</parameter> + becomes optional and defaults to a random value if omitted. <informalexample> <programlisting role="php"> <![CDATA[ Index: octdec.xml =================================================================== RCS file: /repository/phpdoc/en/reference/math/functions/octdec.xml,v retrieving revision 1.2 diff -u -r1.2 octdec.xml --- octdec.xml 17 Apr 2002 06:39:54 -0000 1.2 +++ octdec.xml 4 Dec 2003 17:15:57 -0000 @@ -19,7 +19,10 @@ decimal. </para> <para> - See also <function>decoct</function>. + See also <function>decoct</function>, + <function>bindec</function>, + <function>hexdec</function> and + <function>base_convert</function>. </para> </refsect1> </refentry> Index: round.xml =================================================================== RCS file: /repository/phpdoc/en/reference/math/functions/round.xml,v retrieving revision 1.5 diff -u -r1.5 round.xml --- round.xml 23 Jul 2003 01:34:31 -0000 1.5 +++ round.xml 4 Dec 2003 17:15:57 -0000 @@ -38,6 +38,7 @@ </programlisting> </example> </para> + <!-- It's not true <para> <caution> <simpara> @@ -52,6 +53,7 @@ </simpara> </caution> </para> + --> <para> <note> <simpara> Index: srand.xml =================================================================== RCS file: /repository/phpdoc/en/reference/math/functions/srand.xml,v retrieving revision 1.5 diff -u -r1.5 srand.xml --- srand.xml 30 May 2003 19:48:38 -0000 1.5 +++ srand.xml 4 Dec 2003 17:15:57 -0000 @@ -10,11 +10,13 @@ <title>Description</title> <methodsynopsis> <type>void</type><methodname>srand</methodname> - <methodparam><type>int</type><parameter>seed</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>seed</parameter></methodparam> </methodsynopsis> <para> Seeds the random number generator with <parameter>seed</parameter>. + Since PHP 4.2.0, the <parameter>seed</parameter> + becomes optional and defaults to a random value if omitted. <informalexample> <programlisting role="php"> <![CDATA[
Index: abs.xml =================================================================== RCS file: /repository/phpdoc/en/reference/math/functions/abs.xml,v retrieving revision 1.4 diff -u -r1.4 abs.xml --- abs.xml 16 Jun 2003 18:31:33 -0000 1.4 +++ abs.xml 4 Dec 2003 17:15:57 -0000 @@ -9,7 +9,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>mixed</type><methodname>abs</methodname> + <type>number</type><methodname>abs</methodname> <methodparam><type>mixed</type><parameter>number</parameter></methodparam> </methodsynopsis> <para> Index: atan2.xml =================================================================== RCS file: /repository/phpdoc/en/reference/math/functions/atan2.xml,v retrieving revision 1.2 diff -u -r1.2 atan2.xml --- atan2.xml 17 Apr 2002 06:39:50 -0000 1.2 +++ atan2.xml 4 Dec 2003 17:15:57 -0000 @@ -4,7 +4,7 @@ <refentry id="function.atan2"> <refnamediv> <refname>atan2</refname> - <refpurpose>arc tangent of two variables</refpurpose> + <refpurpose>Arc tangent of two variables</refpurpose> </refnamediv> <refsect1> <title>Description</title> Index: bindec.xml =================================================================== RCS file: /repository/phpdoc/en/reference/math/functions/bindec.xml,v retrieving revision 1.3 diff -u -r1.3 bindec.xml --- bindec.xml 2 Jun 2002 11:56:51 -0000 1.3 +++ bindec.xml 4 Dec 2003 17:15:57 -0000 @@ -22,7 +22,10 @@ 31 bits of 1's or 2147483647 in decimal. </para> <para> - See also: <function>decbin</function>. + See also <function>decbin</function>, + <function>octdec</function>, + <function>hexdec</function> and + <function>base_convert</function>. </para> </refsect1> </refentry> Index: decbin.xml =================================================================== RCS file: /repository/phpdoc/en/reference/math/functions/decbin.xml,v retrieving revision 1.3 diff -u -r1.3 decbin.xml --- decbin.xml 2 Jun 2002 11:56:51 -0000 1.3 +++ decbin.xml 4 Dec 2003 17:15:57 -0000 @@ -18,7 +18,10 @@ 4294967295 in decimal resulting to a string of 32 1's. </para> <para> - See also: <function>bindec</function>. + See also <function>bindec</function>, + <function>decoct</function>, + <function>dechex</function> and + <function>base_convert</function>. </para> </refsect1> </refentry> Index: dechex.xml =================================================================== RCS file: /repository/phpdoc/en/reference/math/functions/dechex.xml,v retrieving revision 1.3 diff -u -r1.3 dechex.xml --- dechex.xml 3 Jun 2002 15:06:16 -0000 1.3 +++ dechex.xml 4 Dec 2003 17:15:57 -0000 @@ -18,7 +18,10 @@ be converted is 2147483647 in decimal resulting to "7fffffff". </para> <para> - See also <function>hexdec</function>. + See also <function>hexdec</function>, + <function>decbin</function>, + <function>decoct</function> and + <function>base_convert</function>. </para> </refsect1> </refentry> Index: decoct.xml =================================================================== RCS file: /repository/phpdoc/en/reference/math/functions/decoct.xml,v retrieving revision 1.3 diff -u -r1.3 decoct.xml --- decoct.xml 2 Jun 2002 11:56:51 -0000 1.3 +++ decoct.xml 4 Dec 2003 17:15:57 -0000 @@ -18,7 +18,10 @@ 2147483647 in decimal resulting to "17777777777". </para> <para> - See also <function>octdec</function>. + See also <function>octdec</function>, + <function>decbin</function>, + <function>dechex</function> and + <function>base_convert</function>. </para> </refsect1> </refentry> Index: hexdec.xml =================================================================== RCS file: /repository/phpdoc/en/reference/math/functions/hexdec.xml,v retrieving revision 1.4 diff -u -r1.4 hexdec.xml --- hexdec.xml 16 Jun 2003 18:31:33 -0000 1.4 +++ hexdec.xml 4 Dec 2003 17:15:57 -0000 @@ -41,7 +41,10 @@ </example> </para> <para> - See also <function>dechex</function>. + See also <function>dechex</function>, + <function>bindec</function>, + <function>octdec</function> and + <function>base_convert</function>. </para> </refsect1> </refentry> Index: log1p.xml =================================================================== RCS file: /repository/phpdoc/en/reference/math/functions/log1p.xml,v retrieving revision 1.2 diff -u -r1.2 log1p.xml --- log1p.xml 17 Apr 2002 06:39:53 -0000 1.2 +++ log1p.xml 4 Dec 2003 17:15:57 -0000 @@ -5,8 +5,8 @@ <refnamediv> <refname>log1p</refname> <refpurpose> - Returns log(1 + number), computed in a way that accurate even when the val -ue of number is close to zero + Returns log(1 + number), computed in a way that accurate even when + the value of number is close to zero </refpurpose> </refnamediv> <refsect1> Index: mt-srand.xml =================================================================== RCS file: /repository/phpdoc/en/reference/math/functions/mt-srand.xml,v retrieving revision 1.5 diff -u -r1.5 mt-srand.xml --- mt-srand.xml 30 May 2003 19:48:38 -0000 1.5 +++ mt-srand.xml 4 Dec 2003 17:15:57 -0000 @@ -10,11 +10,13 @@ <title>Description</title> <methodsynopsis> <type>void</type><methodname>mt_srand</methodname> - <methodparam><type>int</type><parameter>seed</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>seed</parameter></methodparam> </methodsynopsis> <para> Seeds the random number generator with <parameter>seed</parameter>. + Since PHP 4.2.0, the <parameter>seed</parameter> + becomes optional and defaults to a random value if omitted. <informalexample> <programlisting role="php"> <![CDATA[ Index: octdec.xml =================================================================== RCS file: /repository/phpdoc/en/reference/math/functions/octdec.xml,v retrieving revision 1.2 diff -u -r1.2 octdec.xml --- octdec.xml 17 Apr 2002 06:39:54 -0000 1.2 +++ octdec.xml 4 Dec 2003 17:15:57 -0000 @@ -19,7 +19,10 @@ decimal. </para> <para> - See also <function>decoct</function>. + See also <function>decoct</function>, + <function>bindec</function>, + <function>hexdec</function> and + <function>base_convert</function>. </para> </refsect1> </refentry> Index: round.xml =================================================================== RCS file: /repository/phpdoc/en/reference/math/functions/round.xml,v retrieving revision 1.5 diff -u -r1.5 round.xml --- round.xml 23 Jul 2003 01:34:31 -0000 1.5 +++ round.xml 4 Dec 2003 17:15:57 -0000 @@ -38,6 +38,7 @@ </programlisting> </example> </para> + <!-- It's not true <para> <caution> <simpara> @@ -52,6 +53,7 @@ </simpara> </caution> </para> + --> <para> <note> <simpara> Index: srand.xml =================================================================== RCS file: /repository/phpdoc/en/reference/math/functions/srand.xml,v retrieving revision 1.5 diff -u -r1.5 srand.xml --- srand.xml 30 May 2003 19:48:38 -0000 1.5 +++ srand.xml 4 Dec 2003 17:15:57 -0000 @@ -10,11 +10,13 @@ <title>Description</title> <methodsynopsis> <type>void</type><methodname>srand</methodname> - <methodparam><type>int</type><parameter>seed</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>seed</parameter></methodparam> </methodsynopsis> <para> Seeds the random number generator with <parameter>seed</parameter>. + Since PHP 4.2.0, the <parameter>seed</parameter> + becomes optional and defaults to a random value if omitted. <informalexample> <programlisting role="php"> <![CDATA[