From a0ca96f744b095a270e06e7c62f858d47038160a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 6 Sep 2024 23:16:54 +0000 Subject: [PATCH] Auto-generated commit --- CHANGELOG.md | 1 + base/special/atandf/README.md | 3 ++- base/special/atandf/lib/native.js | 1 + base/special/atandf/package.json | 2 +- base/special/atandf/src/main.c | 2 +- base/special/atandf/test/fixtures/julia/REQUIRE | 2 +- 6 files changed, 7 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2c5d35fba..14b20ec99 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -365,6 +365,7 @@ A total of 4 people contributed to this release. Thank you to the following cont
+- [`b7e79ad`](https://github.com/stdlib-js/stdlib/commit/b7e79ad951c4e439ca972dc57dd88de9e38f814c) - **docs:** update function descriptions and fix style nits [(#2870)](https://github.com/stdlib-js/stdlib/pull/2870) _(by Gunj Joshi)_ - [`a294334`](https://github.com/stdlib-js/stdlib/commit/a294334209d981a41f61bda8fd222e1c555f0c5a) - **style:** fix spacing [(#2872)](https://github.com/stdlib-js/stdlib/pull/2872) _(by Gunj Joshi)_ - [`1f5dba3`](https://github.com/stdlib-js/stdlib/commit/1f5dba3820e6cc2283b593ec2bf4942404ddd3d2) - **style:** remove empty line [(#2869)](https://github.com/stdlib-js/stdlib/pull/2869) _(by Gunj Joshi)_ - [`b2268e5`](https://github.com/stdlib-js/stdlib/commit/b2268e57b78b3a774f37e984faebd95ac7c0ba69) - **feat:** add `math/base/special/acoversinf` [(#2860)](https://github.com/stdlib-js/stdlib/pull/2860 ) _(by Gunj Joshi)_ diff --git a/base/special/atandf/README.md b/base/special/atandf/README.md index c859bffab..b96584257 100644 --- a/base/special/atandf/README.md +++ b/base/special/atandf/README.md @@ -20,7 +20,7 @@ limitations under the License. # atandf -> Compute the [arctangent][arctangent] in degrees of a single-precision floating-point number. +> Compute the [arctangent][arctangent] (in degrees) of a single-precision floating-point number.
@@ -36,6 +36,7 @@ Computes the [arctangent][arctangent] (in degrees) of a single-precision floatin ```javascript var sqrtf = require( '@stdlib/math/base/special/sqrtf' ); + var v = atandf( 0.0 ); // returns 0.0 diff --git a/base/special/atandf/lib/native.js b/base/special/atandf/lib/native.js index 57cc6efee..1f911d3cd 100644 --- a/base/special/atandf/lib/native.js +++ b/base/special/atandf/lib/native.js @@ -28,6 +28,7 @@ var addon = require( './../src/addon.node' ); /** * Computes the arctangent (in degrees) of a single-precision floating-point number. * +* @private * @param {number} x - input value * @returns {number} arctangent (in degrees) * diff --git a/base/special/atandf/package.json b/base/special/atandf/package.json index bfd0b5239..0dc84efc5 100644 --- a/base/special/atandf/package.json +++ b/base/special/atandf/package.json @@ -1,7 +1,7 @@ { "name": "@stdlib/math/base/special/atandf", "version": "0.0.0", - "description": "Compute the arctangent(in degrees) of a single-precision floating-point number.", + "description": "Compute the arctangent (in degrees) of a single-precision floating-point number.", "license": "Apache-2.0", "author": { "name": "The Stdlib Authors", diff --git a/base/special/atandf/src/main.c b/base/special/atandf/src/main.c index a160fd0cb..c2dfbd831 100644 --- a/base/special/atandf/src/main.c +++ b/base/special/atandf/src/main.c @@ -24,7 +24,7 @@ * Computes the arctangent (in degrees) of a single-precision floating-point number. * * @param x input value -* @return evaluated rational function +* @return arctangent (in degrees) * * @example * float out = stdlib_base_atandf( 0.5f ); diff --git a/base/special/atandf/test/fixtures/julia/REQUIRE b/base/special/atandf/test/fixtures/julia/REQUIRE index ae40bf736..308c3be89 100644 --- a/base/special/atandf/test/fixtures/julia/REQUIRE +++ b/base/special/atandf/test/fixtures/julia/REQUIRE @@ -1,2 +1,2 @@ julia 1.5 -JSON 0.21 \ No newline at end of file +JSON 0.21