Skip to content

Commit b7e79ad

Browse files
authored
docs: update function descriptions and fix style nits
PR-URL: #2870 Ref: 1f7fd37 Reviewed-by: Athan Reines <[email protected]>
1 parent a294334 commit b7e79ad

File tree

5 files changed

+6
-4
lines changed

5 files changed

+6
-4
lines changed

lib/node_modules/@stdlib/math/base/special/atandf/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ limitations under the License.
2020

2121
# atandf
2222

23-
> Compute the [arctangent][arctangent] in degrees of a single-precision floating-point number.
23+
> Compute the [arctangent][arctangent] (in degrees) of a single-precision floating-point number.
2424
2525
<section class="usage">
2626

@@ -36,6 +36,7 @@ Computes the [arctangent][arctangent] (in degrees) of a single-precision floatin
3636

3737
```javascript
3838
var sqrtf = require( '@stdlib/math/base/special/sqrtf' );
39+
3940
var v = atandf( 0.0 );
4041
// returns 0.0
4142

lib/node_modules/@stdlib/math/base/special/atandf/lib/native.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ var addon = require( './../src/addon.node' );
2828
/**
2929
* Computes the arctangent (in degrees) of a single-precision floating-point number.
3030
*
31+
* @private
3132
* @param {number} x - input value
3233
* @returns {number} arctangent (in degrees)
3334
*

lib/node_modules/@stdlib/math/base/special/atandf/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@stdlib/math/base/special/atandf",
33
"version": "0.0.0",
4-
"description": "Compute the arctangent(in degrees) of a single-precision floating-point number.",
4+
"description": "Compute the arctangent (in degrees) of a single-precision floating-point number.",
55
"license": "Apache-2.0",
66
"author": {
77
"name": "The Stdlib Authors",

lib/node_modules/@stdlib/math/base/special/atandf/src/main.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
* Computes the arctangent (in degrees) of a single-precision floating-point number.
2525
*
2626
* @param x input value
27-
* @return evaluated rational function
27+
* @return arctangent (in degrees)
2828
*
2929
* @example
3030
* float out = stdlib_base_atandf( 0.5f );
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
julia 1.5
2-
JSON 0.21
2+
JSON 0.21

0 commit comments

Comments
 (0)