Fix: README and main.c (Issue #7141f46)

Author: akash8843

lib/node_modules/@stdlib/stats/base/dists/geometric/cdf/README.md

@@ -1,5 +1,4 @@
 <!--
-
 @license Apache-2.0
 
 Copyright (c) 2018 The Stdlib Authors.
@@ -15,7 +14,6 @@ distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
-
 -->
 
 # Cumulative Distribution Function
@@ -24,33 +22,22 @@ limitations under the License.
 
 <section class="intro">
 
-The [cumulative distribution function][cdf] for a [geometric][geometric-distribution] random variable is
-
-<!-- <equation class="equation" label="eq:geometric_cdf" align="center" raw="F(x;p)= \begin{cases} 0 & \text{ for } x < 0 \\ 1-(1 - p)^{\left\lfloor x \right\rfloor+1} & \text{ otherwise} \end{cases}" alt="Cumulative distribution function for a geometric distribution."> -->
+The [cumulative distribution function][cdf] for a [geometric][geometric-distribution] random variable is:
 
 ```math
-F(x;p)= \begin{cases} 0 & \text{ for } x < 0 \\ 1-(1 - p)^{\left\lfloor x \right\rfloor+1} & \text{ otherwise} \end{cases}
+F(x;p)= \begin{cases} 0 & \text{for } x < 0 \\ 1-(1 - p)^{\left\lfloor x \right\rfloor+1} & \text{otherwise} \end{cases}
 ```
 
-<!-- <div class="equation" align="center" data-raw-text="F(x;p)= \begin{cases} 0 &amp; \text{ for } x &lt; 0 \\ 1-(1 - p)^{\left\lfloor x \right\rfloor+1} &amp; \text{ otherwise} \end{cases}" data-equation="eq:geometric_cdf">
-    <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@51534079fef45e990850102147e8945fb023d1d0/lib/node_modules/@stdlib/stats/base/dists/geometric/cdf/docs/img/equation_geometric_cdf.svg" alt="Cumulative distribution function for a geometric distribution.">
-    <br>
-</div> -->
-
-<!-- </equation> -->
-
 where `0 <= p <= 1` is the success probability. `x` denotes the number of _failures_ before the first success.
 
 </section>
 
-<!-- /.intro -->
-
 <section class="usage">
 
 ## Usage
 
 ```javascript
-var cdf = require( '@stdlib/stats/base/dists/geometric/cdf' );
+var cdf = require('@stdlib/stats/base/dists/geometric/cdf');
 ```
 
 #### cdf( x, p )
@@ -87,7 +74,7 @@ y = cdf( 2.0, 1.5 );
 
 #### cdf.factory( p )
 
-Returns a function for evaluating the [cumulative distribution function][cdf] of a [geometric][geometric-distribution] distribution with success probability `p`
+Returns a function for evaluating the [cumulative distribution function][cdf] of a [geometric][geometric-distribution] distribution with success probability `p`.
 
 ```javascript
 var mycdf = cdf.factory( 0.5 );
@@ -100,17 +87,13 @@ y = mycdf( 1.0 );
 
 </section>
 
-<!-- /.usage -->
-
 <section class="examples">
 
 ## Examples
 
-<!-- eslint no-undef: "error" -->
-
 ```javascript
-var randu = require( '@stdlib/random/base/randu' );
-var cdf = require( '@stdlib/stats/base/dists/geometric/cdf' );
+var randu = require('@stdlib/random/base/randu');
+var cdf = require('@stdlib/stats/base/dists/geometric/cdf');
 
 var p;
 var x;
@@ -127,29 +110,18 @@ for ( i = 0; i < 10; i++ ) {
 
 </section>
 
-<!-- /.examples -->
-
-<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
-
 <section class="references">
 
-<!-- C interface documentation. -->
-
-* * *
-
-<section class="c">
-
-## C APIs
-
-<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+## References
 
-<section class="intro">
+- [Cumulative distribution function (Wikipedia)](https://en.wikipedia.org/wiki/Cumulative_distribution_function)
+- [Geometric distribution (Wikipedia)](https://en.wikipedia.org/wiki/Geometric_distribution)
 
 </section>
 
-<!-- /.intro -->
+<section class="c">
 
-<!-- C usage documentation. -->
+## C APIs
 
 <section class="usage">
 
@@ -168,29 +140,8 @@ double out = stdlib_base_dists_geometric_cdf( 2.0, 0.5 );
 // returns 0.875
 ```
 
-The function accepts the following arguments:
-
--   **x**: `[in] double` input value.
--   **p**: `[in] double` probability of success.
-
-```c
-double stdlib_base_dists_geometric_cdf( const double x, const double p );
-```
-
-</section>
-
-<!-- /.usage -->
-
-<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
-
-<section class="notes">
-
 </section>
 
-<!-- /.notes -->
-
-<!-- C API usage examples. -->
-
 <section class="examples">
 
 ### Examples
@@ -203,7 +154,7 @@ double stdlib_base_dists_geometric_cdf( const double x, const double p );
 
 static double random_uniform( const double min, const double max ) {
     double v = (double)rand() / ( (double)RAND_MAX + 1.0 );
-    return min + ( v*(max-min) );
+    return min + ( v * (max - min) );
 }
 
 int main( void ) {
@@ -223,24 +174,16 @@ int main( void ) {
 
 </section>
 
-<!-- /.references -->
-
-<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
-
-<section class="related">
-
 </section>
 
-<!-- /.related -->
-
-<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
-
 <section class="links">
 
 [cdf]: https://en.wikipedia.org/wiki/Cumulative_distribution_function
-
 [geometric-distribution]: https://en.wikipedia.org/wiki/Geometric_distribution
 
 </section>
 
+<!-- /.examples -->
+<!-- /.c -->
 <!-- /.links -->
+

lib/node_modules/@stdlib/stats/base/dists/geometric/cdf/src/main.c

@@ -27,7 +27,7 @@
 *
 * @param x   input value
 * @param p   success probability
-* @returns   evaluated CDF
+* @return    evaluated CDF or NaN
 *
 * @example
 * double y = stdlib_base_dists_geometric_cdf( 2.0, 0.5 );