Skip to content

Commit 8d71c1d

Browse files
kgrytekgryte
committed
Merge branch 'develop' of https://github.com/stdlib-js/stdlib into misc-wip-kgryte
2 parents eb5c99a + 765d81d commit 8d71c1d

141 files changed

Lines changed: 2310 additions & 256 deletions

File tree

Some content is hidden

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

‎etc/eslint/rules/stdlib.js‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3636,6 +3636,52 @@ rules[ 'stdlib/jsdoc-typedef-typos' ] = 'error';
36363636
*/
36373637
rules[ 'stdlib/jsdoc-unordered-list-marker-style' ] = [ 'error', '-' ];
36383638

3639+
/**
3640+
* Enforce that the JSDoc comment documenting a package's main export adheres to stdlib conventions and contains the correct package path.
3641+
*
3642+
* @name jsdoc-main-export
3643+
* @memberof rules
3644+
* @type {string}
3645+
* @default 'error'
3646+
*
3647+
* @example
3648+
* // Bad @stdlib/assert/is-array` main export:
3649+
*
3650+
* /**
3651+
* * Tests if a value is an array.
3652+
* *
3653+
* * @module @stdlib/assert/isarray
3654+
* *
3655+
* * @example
3656+
* * var isArray = require( '@stdlib/assert/is-aray' );
3657+
* *
3658+
* * var bool = isArray( [] );
3659+
* * // returns true
3660+
* *
3661+
* * bool = isArray( {} );
3662+
* * // returns false
3663+
* *\/
3664+
*
3665+
* @example
3666+
* // Good `@stdlib/assert/is-array` main export:
3667+
*
3668+
* /**
3669+
* * Test if a value is an array.
3670+
* *
3671+
* * @module @stdlib/assert/is-array
3672+
* *
3673+
* * @example
3674+
* * var isArray = require( '@stdlib/assert/is-array' );
3675+
* *
3676+
* * var bool = isArray( [] );
3677+
* * // returns true
3678+
* *
3679+
* * bool = isArray( {} );
3680+
* * // returns false
3681+
* *\/
3682+
*/
3683+
rules[ 'stdlib/jsdoc-main-export' ] = 'error';
3684+
36393685
/**
36403686
* Enforce that export statements are placed at the end of a file.
36413687
*

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

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,23 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2018 The Stdlib Authors.
6+
7+
Licensed under the Apache License, Version 2.0 (the "License");
8+
you may not use this file except in compliance with the License.
9+
You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing, software
14+
distributed under the License is distributed on an "AS IS" BASIS,
15+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
See the License for the specific language governing permissions and
17+
limitations under the License.
18+
19+
-->
20+
121
# Tools
222

323
> Project development utilities.

‎lib/node_modules/@stdlib/_tools/doctest/compare-values/lib/index.js‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@
2424
* @module @stdlib/_tools/doctest/compare-values
2525
*
2626
* @example
27+
* var compareValues = require( '@stdlib/_tools/doctest/compare-values' );
28+
*
2729
* var out = compareValues( [ 1, 2, 3 ], '[ 1, 2, ... ]' );
2830
* // returns null
2931
*/

0 commit comments

Comments
 (0)