Skip to content

Commit 83f88d9

Browse files
docs: update function descriptions
PR-URL: #5866 Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
1 parent 1949944 commit 83f88d9

File tree

10 files changed

+19
-19
lines changed

10 files changed

+19
-19
lines changed

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

+4-4
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ limitations under the License.
2020

2121
# sincos
2222

23-
> Simultaneously compute the [sine][@stdlib/math/base/special/sin] and [cosine][@stdlib/math/base/special/cos] of a number.
23+
> Simultaneously compute the [sine][@stdlib/math/base/special/sin] and [cosine][@stdlib/math/base/special/cos] of an angle measured in radians.
2424
2525
<section class="usage">
2626

@@ -32,7 +32,7 @@ var sincos = require( '@stdlib/math/base/special/sincos' );
3232

3333
#### sincos( x )
3434

35-
Simultaneously computes the [sine][@stdlib/math/base/special/sin] and [cosine][@stdlib/math/base/special/cos] of a `number` (in radians).
35+
Simultaneously computes the [sine][@stdlib/math/base/special/sin] and [cosine][@stdlib/math/base/special/cos] of an angle measured in radians.
3636

3737
```javascript
3838
var v = sincos( 0.0 );
@@ -47,7 +47,7 @@ v = sincos( -3.141592653589793/6.0 );
4747

4848
#### sincos.assign( x, out, stride, offset )
4949

50-
Simultaneously computes the [sine][@stdlib/math/base/special/sin] and [cosine][@stdlib/math/base/special/cos] of a `number` (in radians) and assigns results to a provided output array.
50+
Simultaneously computes the [sine][@stdlib/math/base/special/sin] and [cosine][@stdlib/math/base/special/cos] of an angle measured in radians and assigns the results to a provided output array.
5151

5252
```javascript
5353
var Float64Array = require( '@stdlib/array/float64' );
@@ -116,7 +116,7 @@ for ( i = 0; i < x.length; i++ ) {
116116

117117
#### stdlib_base_sincos( x, &sine, &cosine )
118118

119-
Simultaneously computes the [sine][@stdlib/math/base/special/sin] and [cosine][@stdlib/math/base/special/cos] of a `number` (in radians).
119+
Simultaneously computes the [sine][@stdlib/math/base/special/sin] and [cosine][@stdlib/math/base/special/cos] of an angle measured in radians.
120120

121121
```c
122122
double cosine;

lib/node_modules/@stdlib/math/base/special/sincos/docs/repl.txt

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11

22
{{alias}}( x )
3-
Simultaneously computes the sine and cosine of a number.
3+
Simultaneously computes the sine and cosine of an angle measured in radians.
44

55
Parameters
66
----------
@@ -24,9 +24,9 @@
2424
[ NaN, NaN ]
2525

2626

27-
{{alias}}( x, out, stride, offset )
28-
Simultaneously computes the sine and cosine of a number and assigns
29-
results to a provided output array.
27+
{{alias}}.assign( x, out, stride, offset )
28+
Simultaneously computes the sine and cosine of an angle measured in radians
29+
and assigns the results to a provided output array.
3030

3131
Parameters
3232
----------

lib/node_modules/@stdlib/math/base/special/sincos/docs/types/index.d.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ import { Collection } from '@stdlib/types/array';
2424

2525
interface SinCos {
2626
/**
27-
* Simultaneously computes the sine and cosine of a number.
27+
* Simultaneously computes the sine and cosine of an angle measured in radians.
2828
*
2929
* @param x - input value (in radians)
3030
* @returns sine and cosine
@@ -48,7 +48,7 @@ interface SinCos {
4848
( x: number ): Array<number>;
4949

5050
/**
51-
* Simultaneously computes the sine and cosine of a number.
51+
* Simultaneously computes the sine and cosine of an angle measured in radians and assigns the results to a provided output array.
5252
*
5353
* @param x - input value (in radians)
5454
* @param out - output array
@@ -71,7 +71,7 @@ interface SinCos {
7171
}
7272

7373
/**
74-
* Simultaneously computes the sine and cosine of a number.
74+
* Simultaneously computes the sine and cosine of an angle measured in radians.
7575
*
7676
* @param x - input value (in radians)
7777
* @returns sine and cosine

lib/node_modules/@stdlib/math/base/special/sincos/include/stdlib/math/base/special/sincos.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ extern "C" {
2727
#endif
2828

2929
/**
30-
* Simultaneously computes the sine and cosine of a number.
30+
* Simultaneously computes the sine and cosine of an angle measured in radians.
3131
*/
3232
void stdlib_base_sincos( const double x, double *sine, double *cosine );
3333

lib/node_modules/@stdlib/math/base/special/sincos/lib/assign.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ var Y = [ 0.0, 0.0 ];
5656
// MAIN //
5757

5858
/**
59-
* Simultaneously computes the sine and cosine of a number and assigns results to a provided output array.
59+
* Simultaneously computes the sine and cosine of an angle measured in radians and assigns the results to a provided output array.
6060
*
6161
* ## Method
6262
*

lib/node_modules/@stdlib/math/base/special/sincos/lib/index.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
'use strict';
2020

2121
/**
22-
* Simultaneously compute the sine and cosine of a number.
22+
* Simultaneously compute the sine and cosine of an angle measured in radians.
2323
*
2424
* @module @stdlib/math/base/special/sincos
2525
*
@@ -43,7 +43,7 @@
4343
*
4444
* var out = new Float64Array( 2 );
4545
*
46-
* var v = sincos( out, 0.0 );
46+
* var v = sincos.assign( 0.0, out, 1, 0 );
4747
* // return <Float64Array>[ ~0.0, ~1.0 ]
4848
*
4949
* var bool = ( v === out );

lib/node_modules/@stdlib/math/base/special/sincos/lib/main.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ var assign = require( './assign.js' );
2626
// MAIN //
2727

2828
/**
29-
* Simultaneously computes the sine and cosine of a number.
29+
* Simultaneously computes the sine and cosine of an angle measured in radians.
3030
*
3131
* @param {number} x - input value (in radians)
3232
* @returns {Array<number>} sine and cosine

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ var addon = require( './../src/addon.node' );
2727
// MAIN //
2828

2929
/**
30-
* Simultaneously computes the sine and cosine of a number.
30+
* Simultaneously computes the sine and cosine of an angle measured in radians.
3131
*
3232
* @private
3333
* @param {number} x - input value (in radians)

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@stdlib/math/base/special/sincos",
33
"version": "0.0.0",
4-
"description": "Simultaneously compute the sine and cosine of a number.",
4+
"description": "Simultaneously compute the sine and cosine of an angle measured in radians.",
55
"license": "Apache-2.0 AND BSL-1.0",
66
"author": {
77
"name": "The Stdlib Authors",

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ static void kernelSincos( const double x, const double y, double* sine, double*
7676
}
7777

7878
/**
79-
* Simultaneously computes the sine and cosine of a number.
79+
* Simultaneously computes the sine and cosine of an angle measured in radians.
8080
*
8181
* ## Method
8282
*

0 commit comments

Comments
 (0)