Skip to content

Commit 6ce0275

Browse files
committed
docs: remove incorrect hyphens from JSDoc returns annotations
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent f411712 commit 6ce0275

File tree

8 files changed

+11
-11
lines changed

8 files changed

+11
-11
lines changed

lib/node_modules/@stdlib/_tools/changelog/recommend-version-bump/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
* Recommends a version bump based on a list of commits.
2525
*
2626
* @param {Array<Object>} commits - conventional changelog formatted commit message objects
27-
* @returns {(string|null)} - `major`, `minor`, `patch`, or null
27+
* @returns {(string|null)} `major`, `minor`, `patch`, or null
2828
*/
2929
function recommendVersionBump( commits ) {
3030
var hasFeature;

lib/node_modules/@stdlib/array/base/first/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ var resolveGetter = require( '@stdlib/array/base/resolve-getter' );
2929
* Returns the first element of an array-like object.
3030
*
3131
* @param {Collection} arr - input array
32-
* @returns {*} - first element
32+
* @returns {*} first element
3333
*
3434
* @example
3535
* var out = first( [ 1, 2, 3 ] );

lib/node_modules/@stdlib/array/base/last/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ var resolveGetter = require( '@stdlib/array/base/resolve-getter' );
2929
* Returns the last element of an array-like object.
3030
*
3131
* @param {Collection} arr - input array
32-
* @returns {*} - last element
32+
* @returns {*} last element
3333
*
3434
* @example
3535
* var out = last( [ 1, 2, 3 ] );

lib/node_modules/@stdlib/number/float32/base/signbit/lib/native.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ var addon = require( './../src/addon.node' );
3131
*
3232
* @private
3333
* @param {number} x - input value
34-
* @returns {boolean} - boolean indicating if sign bit is on or off
34+
* @returns {boolean} boolean indicating if sign bit is on or off
3535
*
3636
* @example
3737
* var toFloat32 = require( '@stdlib/number/float64/base/to-float32' );

lib/node_modules/@stdlib/number/float32/base/significand/lib/native.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ var addon = require( './../src/addon.node' );
3030
*
3131
* @private
3232
* @param {number} x - input value
33-
* @returns {integer32} - significand
33+
* @returns {integer32} significand
3434
*
3535
* @example
3636
* var toFloat32 = require( '@stdlib/number/float64/base/to-float32' );

lib/node_modules/@stdlib/number/float64/base/signbit/lib/native.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ var addon = require( './../src/addon.node' );
3131
*
3232
* @private
3333
* @param {number} x - input value
34-
* @returns {boolean} - boolean indicating if sign bit is on or off
34+
* @returns {boolean} boolean indicating if sign bit is on or off
3535
*
3636
* @example
3737
* var bool = signbit( 4.0 );

lib/node_modules/@stdlib/string/base/replace-after/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
* @param {string} search - search string
2828
* @param {string} replacement - replacement string
2929
* @param {integer} fromIndex - index at which to start the search
30-
* @returns {string} - string
30+
* @returns {string} output string
3131
*
3232
* @example
3333
* var out = replaceAfter( 'beep boop', ' ', 'foo', 0 );

lib/node_modules/@stdlib/string/num-grapheme-clusters/test/fixtures/script.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ var inmap = require( '@stdlib/utils/inmap' );
3535
*
3636
* @private
3737
* @param {NonNegativeIntegerArray} arr - array of code points
38-
* @returns {string} - UCS-2 encoded string
38+
* @returns {string} UCS-2 encoded string
3939
*/
4040
function ucs2encode( arr ) {
4141
var out;
@@ -60,7 +60,7 @@ function ucs2encode( arr ) {
6060
*
6161
* @private
6262
* @param {integer} c - temp
63-
* @returns {integer} - hexadecimal form
63+
* @returns {integer} hexadecimal form
6464
*/
6565
function convertToHex( c ) {
6666
return parseInt( c, 16 );
@@ -71,7 +71,7 @@ function convertToHex( c ) {
7171
*
7272
* @private
7373
* @param {string} sequence - temp
74-
* @returns {string} - encoded string
74+
* @returns {string} encoded string
7575
*/
7676
function mapper( sequence ) {
7777
var codePoints = inmap( sequence.split(/\s*×\s*/), convertToHex );
@@ -83,7 +83,7 @@ function mapper( sequence ) {
8383
*
8484
* @private
8585
* @param {string} line - line
86-
* @returns {Object} - test data
86+
* @returns {Object} test data
8787
*/
8888
function generateTestData( line ) {
8989
var codePoints;

0 commit comments

Comments
 (0)