Skip to content

Commit 2ff9f93

Browse files
committed
Add notes
1 parent 5ea5b9d commit 2ff9f93

2 files changed

Lines changed: 13 additions & 0 deletions

File tree

lib/node_modules/@stdlib/namespace/pkg2related/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,15 @@ var out = pkg2related( 'unrecognized_pkg_beep_boop_bop_bip' );
6464

6565
<section class="notes">
6666

67+
## Notes
68+
69+
- The function supports providing both internal and standalone package names.
70+
71+
```javascript
72+
var out = pkg2related( '@stdlib/math-base-special-sin' );
73+
// returns [...]
74+
```
75+
6776
</section>
6877

6978
<!-- /.notes -->

lib/node_modules/@stdlib/namespace/pkg2related/docs/repl.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
{{alias}}( pkg )
33
Returns package names related to a specified package name.
44

5+
The function supports both internal and standalone package names.
6+
57
Parameters
68
----------
79
pkg: string
@@ -16,6 +18,8 @@
1618
--------
1719
> var v = {{alias}}( '@stdlib/math/base/special/sin' )
1820
[...]
21+
> v = {{alias}}( '@stdlib/math-base-special-sin' )
22+
[...]
1923

2024
See Also
2125
--------

0 commit comments

Comments
 (0)