Documented stats_standard_deviation.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@332885 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Levi Morrison 2014-02-24 17:00:11 +00:00
parent bec5823af4
commit 0b91b3d1d4

View file

@ -13,8 +13,6 @@
<methodparam choice="opt"><type>bool</type><parameter>sample</parameter><initializer>false</initializer></methodparam>
</methodsynopsis>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@ -24,6 +22,8 @@
<term><parameter>a</parameter></term>
<listitem>
<para>
The array of data to find the standard deviation for. Note that all
values of the array will be cast to <type>float</type>.
</para>
</listitem>
</varlistentry>
@ -31,6 +31,8 @@
<term><parameter>sample</parameter></term>
<listitem>
<para>
Indicates if <parameter>a</parameter> represents a sample of the
population; defaults to false.
</para>
</listitem>
</varlistentry>
@ -41,18 +43,17 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the standard deviation on success; <type>false</type> on failure.
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
<refsect1 role="errors"><!-- {{{ -->
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
Raises an E_WARNING when there are fewer than 2 values in
<parameter>a</parameter>.
</para>
</refsect1>
-->
</refsect1><!-- }}} -->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">