Skip to content

Commit 8ef1f9e

Browse files
authored
docs: update related packages sections
PR-URL: #1233 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 8738256 commit 8ef1f9e

File tree

8 files changed

+47
-8
lines changed

8 files changed

+47
-8
lines changed

lib/node_modules/@stdlib/buffer/reviver/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,12 @@ console.log( out );
128128

129129
[@stdlib/buffer/to-json]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/buffer/to-json
130130

131+
<!-- <related-links> -->
132+
133+
134+
135+
<!-- </related-links> -->
136+
131137
</section>
132138

133139
<!-- /.links -->

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

+12
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,12 @@ for ( i = 0; i < values.length; i++ ) {
9797

9898
<section class="related">
9999

100+
* * *
101+
102+
## See Also
103+
104+
- <span class="package-name">[`@stdlib/math/base/special/factorial`][@stdlib/math/base/special/factorial]</span><span class="delimiter">: </span><span class="description">evaluate a factorial.</span>
105+
100106
</section>
101107

102108
<!-- /.related -->
@@ -107,6 +113,12 @@ for ( i = 0; i < values.length; i++ ) {
107113

108114
[double-factorial]: https://en.wikipedia.org/wiki/Double_factorial
109115

116+
<!-- <related-links> -->
117+
118+
[@stdlib/math/base/special/factorial]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/factorial
119+
120+
<!-- </related-links> -->
121+
110122
</section>
111123

112124
<!-- /.links -->

lib/node_modules/@stdlib/number/float32/base/to-uint32/README.md

+12
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,12 @@ for ( i = 0; i < 500; i++ ) {
9898

9999
<section class="related">
100100

101+
* * *
102+
103+
## See Also
104+
105+
- <span class="package-name">[`@stdlib/number/float32/base/to-int32`][@stdlib/number/float32/base/to-int32]</span><span class="delimiter">: </span><span class="description">convert a single-precision floating-point number to a signed 32-bit integer.</span>
106+
101107
</section>
102108

103109
<!-- /.related -->
@@ -108,6 +114,12 @@ for ( i = 0; i < 500; i++ ) {
108114

109115
[ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985
110116

117+
<!-- <related-links> -->
118+
119+
[@stdlib/number/float32/base/to-int32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/float32/base/to-int32
120+
121+
<!-- </related-links> -->
122+
111123
</section>
112124

113125
<!-- /.links -->

lib/node_modules/@stdlib/random/base/randn/README.md

-2
Original file line numberDiff line numberDiff line change
@@ -403,8 +403,6 @@ for ( i = 0; i < 100; i++ ) {
403403

404404
<!-- <related-links> -->
405405

406-
[@stdlib/random/base/improved-ziggurat]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/base/improved-ziggurat
407-
408406
[@stdlib/random/base/randu]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/base/randu
409407

410408
<!-- </related-links> -->

lib/node_modules/@stdlib/stats/base/dists/truncated-normal/README.md

-4
Original file line numberDiff line numberDiff line change
@@ -55,16 +55,12 @@ The namespace contains the following functions for calculating distribution prop
5555

5656
<!-- <toc pattern="*+(entropy|kurtosis|mean|median|mode|skewness|stdev|variance)*"> -->
5757

58-
59-
6058
<!-- </toc> -->
6159

6260
The namespace contains a constructor function for creating a [truncated normal][truncated-normal-distribution] distribution object.
6361

6462
<!-- <toc pattern="*ctor*"> -->
6563

66-
67-
6864
<!-- </toc> -->
6965

7066
</section>

lib/node_modules/@stdlib/string/base/left-pad/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ str = lpad( 'boop', 12, 'beep' );
7070

7171
- The function is **not** guaranteed to return a string having a length exactly equal to `len` (as explained above).
7272
- The function does **not** truncate `pad` (from the end) in order to ensure the returned string has length `len`.
73-
73+
7474
To replicate [`String.prototype.padStart`][mdn-string-padstart] truncation behavior
7575

7676
```javascript

lib/node_modules/@stdlib/string/for-each/README.md

+13-1
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ The function supports the following options:
9191
- `'grapheme'`: grapheme clusters. Appropriate for strings containing visual characters which can span multiple Unicode code points (e.g., emoji).
9292
- `'code_point'`: Unicode code points. Appropriate for strings containing visual characters which are comprised of more than one Unicode code unit (e.g., ideographic symbols and punctuation and mathematical alphanumerics).
9393
- `'code_unit'`: UTF-16 code units. Appropriate for strings containing visual characters drawn from the basic multilingual plane (BMP) (e.g., common characters, such as those from the Latin, Greek, and Cyrillic alphabets).
94-
94+
9595
Default: `'grapheme'`.
9696

9797
</section>
@@ -147,6 +147,12 @@ forEach( '\uD834\uDD1E', log );
147147

148148
<section class="related">
149149

150+
* * *
151+
152+
## See Also
153+
154+
- <span class="package-name">[`@stdlib/utils/for-each`][@stdlib/utils/for-each]</span><span class="delimiter">: </span><span class="description">invoke a function for each element in a collection.</span>
155+
150156
</section>
151157

152158
<!-- /.related -->
@@ -155,6 +161,12 @@ forEach( '\uD834\uDD1E', log );
155161

156162
<section class="links">
157163

164+
<!-- <related-links> -->
165+
166+
[@stdlib/utils/for-each]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/for-each
167+
168+
<!-- </related-links> -->
169+
158170
</section>
159171

160172
<!-- /.links -->

lib/node_modules/@stdlib/string/snakecase/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,7 @@ foo_bar
178178
- <span class="package-name">[`@stdlib/string/camelcase`][@stdlib/string/camelcase]</span><span class="delimiter">: </span><span class="description">convert a string to camel case.</span>
179179
- <span class="package-name">[`@stdlib/string/constantcase`][@stdlib/string/constantcase]</span><span class="delimiter">: </span><span class="description">convert a string to constant case.</span>
180180
- <span class="package-name">[`@stdlib/string/kebabcase`][@stdlib/string/kebabcase]</span><span class="delimiter">: </span><span class="description">convert a string to kebab case.</span>
181+
- <span class="package-name">[`@stdlib/string/pascalcase`][@stdlib/string/pascalcase]</span><span class="delimiter">: </span><span class="description">convert a string to Pascal case.</span>
181182

182183
</section>
183184

@@ -199,6 +200,8 @@ foo_bar
199200

200201
[@stdlib/string/kebabcase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/kebabcase
201202

203+
[@stdlib/string/pascalcase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/pascalcase
204+
202205
<!-- </related-links> -->
203206

204207
</section>

0 commit comments

Comments
 (0)