Skip to content

Commit f387603

Browse files
PlaneshifterPlaneshifter
committed
docs: consistently use declarative instead of imperative sentences outside of intros
1 parent ed44fee commit f387603

File tree

69 files changed

+74
-74
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

69 files changed

+74
-74
lines changed

‎lib/node_modules/@stdlib/_tools/bib/citation-reference/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ function clbk( error, reference ) {
100100

101101
#### toReference.sync( id\[, options] )
102102

103-
Synchronously return a reference corresponding to a citation identifier.
103+
Synchronously returns a reference corresponding to a citation identifier.
104104

105105
<!-- run-disable -->
106106

‎lib/node_modules/@stdlib/_tools/github/starred/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ var starred = require( '@stdlib/_tools/github/starred' );
4444

4545
#### starred( opts, clbk )
4646

47-
Get a list of repositories a user has [starred][github-starred].
47+
Gets a list of repositories a user has [starred][github-starred].
4848

4949
<!-- run-disable -->
5050

‎lib/node_modules/@stdlib/_tools/github/subscriptions/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ var subscriptions = require( '@stdlib/_tools/github/subscriptions' );
4242

4343
#### subscriptions( opts, clbk )
4444

45-
Get a user's list of repository [subscriptions][github-watching].
45+
Gets a user's list of repository [subscriptions][github-watching].
4646

4747
<!-- run-disable -->
4848

‎lib/node_modules/@stdlib/_tools/lint/pkg-json/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ var lint = require( '@stdlib/_tools/lint/pkg-json' );
3232

3333
#### lint( \[options,] clbk )
3434

35-
Asynchronously lint `package.json` files.
35+
Asynchronously lints `package.json` files.
3636

3737
```javascript
3838
lint( done );
@@ -124,7 +124,7 @@ function done( error, errs ) {
124124

125125
#### lint.sync( \[options] )
126126

127-
Synchronously lint `package.json` files.
127+
Synchronously lints `package.json` files.
128128

129129
```javascript
130130
var errs = lint.sync();

‎lib/node_modules/@stdlib/_tools/lint/repl-txt/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ var lint = require( '@stdlib/_tools/lint/repl-txt' );
3232

3333
#### lint( \[options,] clbk )
3434

35-
Asynchronously lint `repl.txt` files.
35+
Asynchronously lints `repl.txt` files.
3636

3737
```javascript
3838
lint( done );
@@ -124,7 +124,7 @@ function done( error, errs ) {
124124

125125
#### lint.sync( \[options] )
126126

127-
Synchronously lint `repl.txt` files.
127+
Synchronously lints `repl.txt` files.
128128

129129
```javascript
130130
var errs = lint.sync();

‎lib/node_modules/@stdlib/_tools/pkgs/addons/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ var findAddons = require( '@stdlib/_tools/pkgs/addons' );
3232

3333
#### findAddons( \[options,] clbk )
3434

35-
Asynchronously search for [add-ons][node-add-ons].
35+
Asynchronously searches for [add-ons][node-add-ons].
3636

3737
```javascript
3838
findAddons( onAddons );

‎lib/node_modules/@stdlib/_tools/pkgs/clis/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ var findCLIs = require( '@stdlib/_tools/pkgs/clis' );
3232

3333
#### findCLIs( \[options,] clbk )
3434

35-
Asynchronously search for package command-line interfaces.
35+
Asynchronously searches for package command-line interfaces.
3636

3737
```javascript
3838
findCLIs( onCLIs );

‎lib/node_modules/@stdlib/_tools/pkgs/cmds/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ var findCommands = require( '@stdlib/_tools/pkgs/cmds' );
3232

3333
#### findCommands( \[options,] clbk )
3434

35-
Asynchronously search for package command-line interface commands.
35+
Asynchronously searches for package command-line interface commands.
3636

3737
<!-- run-disable -->
3838

‎lib/node_modules/@stdlib/_tools/pkgs/find/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ var findPkgs = require( '@stdlib/_tools/pkgs/find' );
3232

3333
#### findPkgs( \[options,] clbk )
3434

35-
Asynchronously search for packages.
35+
Asynchronously searches for packages.
3636

3737
```javascript
3838
findPkgs( onPkgs );

‎lib/node_modules/@stdlib/_tools/pkgs/includes/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ var findIncludes = require( '@stdlib/_tools/pkgs/includes' );
3232

3333
#### findIncludes( \[options,] clbk )
3434

35-
Asynchronously search for package `include` directories.
35+
Asynchronously searches for package `include` directories.
3636

3737
<!-- run-disable -->
3838

‎lib/node_modules/@stdlib/_tools/pkgs/namespace-readmes/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ var findREADMEs = require( '@stdlib/_tools/pkgs/namespace-readmes' );
3232

3333
#### findREADMEs( \[options,] clbk )
3434

35-
Asynchronously search for namespace package READMEs.
35+
Asynchronously searches for namespace package READMEs.
3636

3737
<!-- run-disable -->
3838

‎lib/node_modules/@stdlib/_tools/pkgs/readmes/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ var findREADMEs = require( '@stdlib/_tools/pkgs/readmes' );
3232

3333
#### findREADMEs( \[options,] clbk )
3434

35-
Asynchronously search for package READMEs.
35+
Asynchronously searches for package READMEs.
3636

3737
<!-- run-disable -->
3838

‎lib/node_modules/@stdlib/_tools/pkgs/repl-help/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ var findREPLHelp = require( '@stdlib/_tools/pkgs/repl-help' );
3232

3333
#### findREPLHelp( \[options,] clbk )
3434

35-
Asynchronously search for package REPL help files.
35+
Asynchronously searches for package REPL help files.
3636

3737
<!-- run-disable -->
3838

‎lib/node_modules/@stdlib/_tools/pkgs/types/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ var findTypes = require( '@stdlib/_tools/pkgs/types' );
3232

3333
#### findTypes( \[options,] clbk )
3434

35-
Asynchronously search for packages containing TypeScript declarations.
35+
Asynchronously searches for packages containing TypeScript declarations.
3636

3737
<!-- run-disable -->
3838

‎lib/node_modules/@stdlib/_tools/pkgs/wasm/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ var findWASM = require( '@stdlib/_tools/pkgs/wasm' );
3232

3333
#### findWASM( \[options,] clbk )
3434

35-
Asynchronously search for packages containing [WebAssembly][webassembly].
35+
Asynchronously searches for packages containing [WebAssembly][webassembly].
3636

3737
```javascript
3838
findWASM( onPkgs );

‎lib/node_modules/@stdlib/_tools/tests/browser-build/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ var build = require( '@stdlib/_tools/tests/browser-build' );
4242

4343
#### build( root, output, \[options,] clbk )
4444

45-
Given a `root` directory from which to search for tests and an output directory, build assets for running tests in a web browser.
45+
Given a `root` directory from which to search for tests and an output directory, builds assets for running tests in a web browser.
4646

4747
<!-- eslint-disable stdlib/no-redeclare -->
4848

‎lib/node_modules/@stdlib/_tools/tests/bundle/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ var bundle = require( '@stdlib/_tools/tests/bundle' );
4242

4343
#### bundle( root, \[options,] clbk )
4444

45-
Given a `root` directory from which to search for tests, bundle tests into a single file using [browserify][browserify].
45+
Given a `root` directory from which to search for tests, bundles tests into a single file using [browserify][browserify].
4646

4747
```javascript
4848
var cwd = require( '@stdlib/process/cwd' );

‎lib/node_modules/@stdlib/array/base/accessor/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ var v = arr.get( 0 );
9191

9292
#### AccessorArray.prototype.set( v\[, i] )
9393

94-
Set an array element.
94+
Sets an array element.
9595

9696
```javascript
9797
var arr = new AccessorArray( [ 1, 2, 3 ] );

‎lib/node_modules/@stdlib/array/base/at/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ var at = require( '@stdlib/array/base/at' );
4242

4343
#### at( x, index )
4444

45-
Return an element from an array.
45+
Returns an element from an array.
4646

4747
```javascript
4848
var x = [ 1, 2, 3, 4 ];

‎lib/node_modules/@stdlib/array/base/at2d/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ var at2d = require( '@stdlib/array/base/at2d' );
4242

4343
#### at2d( x, i0, i1 )
4444

45-
Return an element from a two-dimensional nested array.
45+
Returns an element from a two-dimensional nested array.
4646

4747
```javascript
4848
var x = [ [ 1, 2 ], [ 3, 4 ] ];

‎lib/node_modules/@stdlib/array/base/at3d/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ var at3d = require( '@stdlib/array/base/at3d' );
4242

4343
#### at3d( x, i0, i1, i2 )
4444

45-
Return an element from a three-dimensional nested array.
45+
Returns an element from a three-dimensional nested array.
4646

4747
```javascript
4848
var x = [ [ [ 1, 2 ], [ 3, 4 ] ] ];

‎lib/node_modules/@stdlib/array/base/at4d/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ var at4d = require( '@stdlib/array/base/at4d' );
4242

4343
#### at4d( x, i0, i1, i2, i3 )
4444

45-
Return an element from a four-dimensional nested array.
45+
Returns an element from a four-dimensional nested array.
4646

4747
```javascript
4848
var x = [ [ [ [ 1, 2 ], [ 3, 4 ] ] ] ];

‎lib/node_modules/@stdlib/array/base/at5d/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ var at5d = require( '@stdlib/array/base/at5d' );
4242

4343
#### at5d( x, i0, i1, i2, i3, i4 )
4444

45-
Return an element from a five-dimensional nested array.
45+
Returns an element from a five-dimensional nested array.
4646

4747
```javascript
4848
var x = [ [ [ [ [ 1, 2 ], [ 3, 4 ] ] ] ] ];

‎lib/node_modules/@stdlib/array/base/atnd/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ var atnd = require( '@stdlib/array/base/atnd' );
4242

4343
#### atnd( x, i0\[, ...indices] )
4444

45-
Return an element from an n-dimensional nested array.
45+
Returns an element from an n-dimensional nested array.
4646

4747
```javascript
4848
var x = [ [ 1, 2 ], [ 3, 4 ] ];

‎lib/node_modules/@stdlib/array/base/cusome-by-right/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ var cusomeByRight = require( '@stdlib/array/base/cusome-by-right' );
3232

3333
#### cusomeByRight( x, n, predicate\[, thisArg ] )
3434

35-
Cumulatively test whether at least `n` elements in a provided array pass a test implemented by a `predicate` function, while iterating from right-to-left.
35+
Cumulatively tests whether at least `n` elements in a provided array pass a test implemented by a `predicate` function, while iterating from right-to-left.
3636

3737
```javascript
3838
function fcn( value ) {
@@ -74,7 +74,7 @@ var count = context.count;
7474

7575
#### cusomeByRight.assign( x, n, out, stride, offset, predicate\[, thisArg ] )
7676

77-
Cumulatively test whether at least `n` elements in a provided array pass a test implemented by a `predicate` function, while iterating from right-to-left and assign the results to the elements in the output array.
77+
Cumulatively tests whether at least `n` elements in a provided array pass a test implemented by a `predicate` function, while iterating from right-to-left and assign the results to the elements in the output array.
7878

7979
```javascript
8080
function fcn( v ) {

‎lib/node_modules/@stdlib/assert/is-circular/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ var isCircular = require( '@stdlib/assert/is-circular' );
3232

3333
#### isCircular( value )
3434

35-
Test if an object-like `value` contains a circular reference.
35+
Tests if an object-like `value` contains a circular reference.
3636

3737
```javascript
3838
var obj = {

‎lib/node_modules/@stdlib/assert/is-same-array-like-object/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ var isSameArrayLikeObject = require( '@stdlib/assert/is-same-array-like-object'
3232

3333
#### isSameArrayLikeObject( v1, v2 )
3434

35-
Test if two arguments are both [array-like objects][@stdlib/assert/is-array-like-object] and have the [same values][@stdlib/assert/is-same-value].
35+
Tests if two arguments are both [array-like objects][@stdlib/assert/is-array-like-object] and have the [same values][@stdlib/assert/is-same-value].
3636

3737
```javascript
3838
var x = [ 1.0, 2.0 ];

‎lib/node_modules/@stdlib/blas/base/diagonal-type-str2enum/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ var str2enum = require( '@stdlib/blas/base/diagonal-type-str2enum' );
4242

4343
#### str2enum( diagonal )
4444

45-
Return the enumeration constant associated with a BLAS diagonal-type.
45+
Returns the enumeration constant associated with a BLAS diagonal-type.
4646

4747
```javascript
4848
var v = str2enum( 'unit' );

‎lib/node_modules/@stdlib/blas/base/layout-str2enum/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ var str2enum = require( '@stdlib/blas/base/layout-str2enum' );
4242

4343
#### str2enum( layout )
4444

45-
Return the enumeration constant associated with a BLAS memory layout string.
45+
Returns the enumeration constant associated with a BLAS memory layout string.
4646

4747
```javascript
4848
var v = str2enum( 'row-major' );

‎lib/node_modules/@stdlib/blas/base/matrix-triangle-str2enum/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ var str2enum = require( '@stdlib/blas/base/matrix-triangle-str2enum' );
4242

4343
#### str2enum( operation )
4444

45-
Return the enumeration constant associated with a BLAS matrix triangle.
45+
Returns the enumeration constant associated with a BLAS matrix triangle.
4646

4747
```javascript
4848
var v = str2enum( 'upper' );

‎lib/node_modules/@stdlib/blas/base/operation-side-str2enum/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ var str2enum = require( '@stdlib/blas/base/operation-side-str2enum' );
4242

4343
#### str2enum( operation )
4444

45-
Return the enumeration constant associated with a BLAS operation side.
45+
Returns the enumeration constant associated with a BLAS operation side.
4646

4747
```javascript
4848
var v = str2enum( 'left' );

‎lib/node_modules/@stdlib/blas/base/transpose-operation-str2enum/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ var str2enum = require( '@stdlib/blas/base/transpose-operation-str2enum' );
4242

4343
#### str2enum( operation )
4444

45-
Return the enumeration constant associated with a BLAS transpose operation.
45+
Returns the enumeration constant associated with a BLAS transpose operation.
4646

4747
```javascript
4848
var v = str2enum( 'transpose' );

‎lib/node_modules/@stdlib/blas/base/zswap/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ var zswap = require( '@stdlib/blas/base/zswap' );
4040

4141
#### zswap( N, x, strideX, y, strideY )
4242

43-
Interchange two complex double-precision floating-point vectors.
43+
Interchanges two complex double-precision floating-point vectors.
4444

4545
```javascript
4646
var Complex128Array = require( '@stdlib/array/complex128' );
@@ -151,7 +151,7 @@ im = imag( z );
151151

152152
#### zswap.ndarray( N, x, strideX, offsetX, y, strideY, offsetY )
153153

154-
Interchange two complex double-precision floating-point vectors using alternative indexing semantics.
154+
Interchanges two complex double-precision floating-point vectors using alternative indexing semantics.
155155

156156
```javascript
157157
var Complex128Array = require( '@stdlib/array/complex128' );

‎lib/node_modules/@stdlib/complex/float32/parse/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ var parseComplex64 = require( '@stdlib/complex/float32/parse' );
4242

4343
#### parseComplex64( str )
4444

45-
Parse a string representation of a 64-bit [complex number][@stdlib/complex/float32/ctor].
45+
Parses a string representation of a 64-bit [complex number][@stdlib/complex/float32/ctor].
4646

4747
```javascript
4848
var parseComplex64 = require( '@stdlib/complex/float32/parse' );

‎lib/node_modules/@stdlib/complex/float64/parse/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ var parseComplex128 = require( '@stdlib/complex/float64/parse' );
4242

4343
#### parseComplex128( str )
4444

45-
Parse a string representation of a 128-bit [complex number][@stdlib/complex/float64/ctor].
45+
Parses a string representation of a 128-bit [complex number][@stdlib/complex/float64/ctor].
4646

4747
```javascript
4848
var real = require( '@stdlib/complex/float64/real' );

‎lib/node_modules/@stdlib/fs/unlink/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ var unlink = require( '@stdlib/fs/unlink' );
3232

3333
#### unlink( path, clbk )
3434

35-
Asynchronously remove a directory entry specified by `path`.
35+
Asynchronously removes a directory entry specified by `path`.
3636

3737
<!-- run-disable -->
3838

‎lib/node_modules/@stdlib/fs/write-file/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ var writeFile = require( '@stdlib/fs/write-file' );
3232

3333
#### writeFile( file, data\[, options], clbk )
3434

35-
Asynchronously write `data` to a `file`.
35+
Asynchronously writes `data` to a `file`.
3636

3737
```javascript
3838
var join = require( 'path' ).join;

‎lib/node_modules/@stdlib/math/base/assert/is-safe-integer/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ bool = isSafeInteger( NaN );
123123

124124
#### stdlib_base_is_safe_integer( x )
125125

126-
Test if a finite [double-precision floating-point number][ieee754] is a safe integer.
126+
Tests if a finite [double-precision floating-point number][ieee754] is a safe integer.
127127

128128
```c
129129
#include <stdbool.h>

‎lib/node_modules/@stdlib/math/base/special/acsch/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ for ( i = 0; i < x.length; i++ ) {
111111

112112
#### stdlib_base_acsch( x )
113113

114-
Compute the [hyperbolic arccosecant][inverse-hyperbolic-functions] of a double-precision floating-point number.
114+
Computes the [hyperbolic arccosecant][inverse-hyperbolic-functions] of a double-precision floating-point number.
115115

116116
```c
117117
double out = stdlib_base_acsch( 1.0 );

‎lib/node_modules/@stdlib/math/base/special/ahavercos/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ for ( i = 0; i < x.length; i++ ) {
133133

134134
#### stdlib_base_ahavercos( x )
135135

136-
Compute the [inverse half-value versed cosine][archavercosine] of a double-precision floating-point number (in radians).
136+
Computes the [inverse half-value versed cosine][archavercosine] of a double-precision floating-point number (in radians).
137137

138138
```c
139139
double out = stdlib_base_ahavercos( 0.0 );

0 commit comments

Comments
 (0)