Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -725,6 +725,7 @@ A total of 90 issues were closed in this release:
 
 <details>
 
+-   [`e81a8c0`](https://github.com/stdlib-js/stdlib/commit/e81a8c0c8501d4bc3e3b3843a86476a2e088a9d6) - **docs:** fix C examples [(#11134)](https://github.com/stdlib-js/stdlib/pull/11134) _(by anee3)_
 -   [`cd99fef`](https://github.com/stdlib-js/stdlib/commit/cd99fef661e7a5f6e600ee81295ec4dbc8501187) - **docs:** fix C examples [(#11135)](https://github.com/stdlib-js/stdlib/pull/11135) _(by anee3)_
 -   [`b20816f`](https://github.com/stdlib-js/stdlib/commit/b20816f0b727f9a365b0fd526092db9cd2ad75fc) - **docs:** fix incorrect return annotation [(#11128)](https://github.com/stdlib-js/stdlib/pull/11128) _(by anee3)_
 -   [`b7feba2`](https://github.com/stdlib-js/stdlib/commit/b7feba2d63f20199707be94ffa1284538e0c4395) - **docs:** fix C example variable declaration [(#11127)](https://github.com/stdlib-js/stdlib/pull/11127) _(by anee3)_

base/special/fibonacci-indexf/src/main.c

@@ -38,7 +38,7 @@ static const float SQRT_5 = 2.23606797749979f;
 * @return     Fibonacci number index
 *
 * @example
-* float out = stdlib_base_fibonacci_index( 2.0f );
+* float out = stdlib_base_fibonacci_indexf( 2.0f );
 * // returns 3.0f
 */
 float stdlib_base_fibonacci_indexf( const float F ) {

base/special/gamma-lanczos-sum/src/main.c

@@ -66,7 +66,7 @@ static double rational_pq( const double x ) {
 * @return     Lanczos sum approximation
 *
 * @example
-* double v = stdlib_base_gammaLanczosSum( 4.0 );
+* double v = stdlib_base_gamma_lanczos_sum( 4.0 );
 * // returns ~950.366
 */
 double stdlib_base_gamma_lanczos_sum( const double x ) {

base/special/hyp2f1/src/main.c

@@ -408,7 +408,7 @@ static double hyt2f1( const double a, const double b, const double c, const doub
 * @return         function value
 *
 * @example
-* double v = stdlib_base_gamma( 1.0, 1.0, 1.0, 0.0 );
+* double v = stdlib_base_hyp2f1( 1.0, 1.0, 1.0, 0.0 );
 * // returns 1.0
 */
 double stdlib_base_hyp2f1( const double a, const double b, const double c, const double x ) {

base/special/kronecker-deltaf/src/main.c

@@ -27,11 +27,11 @@
 * @return        function value
 *
 * @example
-* float v = stdlib_base_kronecker_delta( 3.0f, 3.0f );
+* float v = stdlib_base_kronecker_deltaf( 3.0f, 3.0f );
 * // returns 1.0f
 *
 * @example
-* float v = stdlib_base_kronecker_delta( 3.0f, 3.14f );
+* float v = stdlib_base_kronecker_deltaf( 3.0f, 3.14f );
 * // returns 0.0f
 */
 float stdlib_base_kronecker_deltaf( const float i, const float j ) {

base/special/log1pmx/src/main.c

@@ -43,7 +43,7 @@
 *
 * @example
 * double out = stdlib_base_log1pmx( 0.0 );
-* // returns ~0.693
+* // returns 0.0
 */
 double stdlib_base_log1pmx( const double x ) {
 	double ax;

base/special/sech/src/main.c

@@ -26,7 +26,7 @@
 * @return     hyperbolic secant
 *
 * @example
-* var v = stdlib_base_sech( 2.0 );
+* double v = stdlib_base_sech( 2.0 );
 * // returns ~0.2658
 */
 double stdlib_base_sech( const double x ) {

base/special/sqrtpi/src/main.c

@@ -28,7 +28,7 @@
 *
 * @example
 * double out = stdlib_base_sqrtpi( 4.0 );
-* // returns 3.5449
+* // returns ~3.5449
 */
 double stdlib_base_sqrtpi( const double x ) {
 	return stdlib_base_sqrt( x * STDLIB_CONSTANT_FLOAT64_PI );

base/special/trunc10/src/main.c

@@ -30,7 +30,7 @@
 * @return     rounded value
 *
 * @example
-* double y = stdlib_base_trunc2( 13.0 );
+* double y = stdlib_base_trunc10( 13.0 );
 * // returns 10.0
 */
 double stdlib_base_trunc10( const double x ) {

base/special/vercosf/src/main.c

@@ -27,7 +27,7 @@
 *
 * @example
 * float y = stdlib_base_vercosf( 3.141592653589793f / 2.0f );
-* // returns 1.0f
+* // returns ~1.0f
 */
 float stdlib_base_vercosf( const float x ) {
 	return 1.0f + stdlib_base_cosf( x );