Skip to content

Commit 53fd65d

Browse files
authored
docs: update related packages sections
PR-URL: #2240 Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
1 parent ec6af48 commit 53fd65d

File tree

14 files changed

+185
-0
lines changed

14 files changed

+185
-0
lines changed

lib/node_modules/@stdlib/assert/is-constantcase/README.md

+11
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,13 @@ true
173173

174174
<section class="related">
175175

176+
* * *
177+
178+
## See Also
179+
180+
- <span class="package-name">[`@stdlib/assert/is-string`][@stdlib/assert/is-string]</span><span class="delimiter">: </span><span class="description">test if a value is a string.</span>
181+
- <span class="package-name">[`@stdlib/assert/is-camelcase`][@stdlib/assert/is-camelcase]</span><span class="delimiter">: </span><span class="description">test if a value is a camelcase string.</span>
182+
176183
</section>
177184

178185
<!-- /.related -->
@@ -187,6 +194,10 @@ true
187194

188195
<!-- <related-links> -->
189196

197+
[@stdlib/assert/is-string]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-string
198+
199+
[@stdlib/assert/is-camelcase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-camelcase
200+
190201
<!-- </related-links> -->
191202

192203
</section>

lib/node_modules/@stdlib/constants/float32/sign-mask/README.md

+18
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,14 @@ Macro for the mask for the sign bit of a [single-precision floating-point number
150150

151151
<section class="related">
152152

153+
* * *
154+
155+
## See Also
156+
157+
- <span class="package-name">[`@stdlib/constants/float32/exponent-mask`][@stdlib/constants/float32/exponent-mask]</span><span class="delimiter">: </span><span class="description">mask for the exponent of a single-precision floating-point number.</span>
158+
- <span class="package-name">[`@stdlib/constants/float32/significand-mask`][@stdlib/constants/float32/significand-mask]</span><span class="delimiter">: </span><span class="description">mask for the significand of a single-precision floating-point number.</span>
159+
- <span class="package-name">[`@stdlib/constants/float32/abs-mask`][@stdlib/constants/float32/abs-mask]</span><span class="delimiter">: </span><span class="description">mask for excluding the sign bit of a single-precision floating-point number.</span>
160+
153161
</section>
154162

155163
<!-- /.related -->
@@ -160,6 +168,16 @@ Macro for the mask for the sign bit of a [single-precision floating-point number
160168

161169
[ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985
162170

171+
<!-- <related-links> -->
172+
173+
[@stdlib/constants/float32/exponent-mask]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/exponent-mask
174+
175+
[@stdlib/constants/float32/significand-mask]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/significand-mask
176+
177+
[@stdlib/constants/float32/abs-mask]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/abs-mask
178+
179+
<!-- </related-links> -->
180+
163181
</section>
164182

165183
<!-- /.links -->

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

+14
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,14 @@ int main( void ) {
178178

179179
<section class="related">
180180

181+
* * *
182+
183+
## See Also
184+
185+
- <span class="package-name">[`@stdlib/math/base/special/asin`][@stdlib/math/base/special/asin]</span><span class="delimiter">: </span><span class="description">compute the arcsine of a double-precision floating-point number.</span>
186+
- <span class="package-name">[`@stdlib/math/base/special/asinh`][@stdlib/math/base/special/asinh]</span><span class="delimiter">: </span><span class="description">compute the hyperbolic arcsine of a double-precision floating-point number.</span>
187+
- <span class="package-name">[`@stdlib/math/base/special/atand`][@stdlib/math/base/special/atand]</span><span class="delimiter">: </span><span class="description">compute the arctangent(in degrees) of a double-precision floating-point number.</span>
188+
181189
</section>
182190

183191
<!-- /.related -->
@@ -190,6 +198,12 @@ int main( void ) {
190198

191199
<!-- <related-links> -->
192200

201+
[@stdlib/math/base/special/asin]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/asin
202+
203+
[@stdlib/math/base/special/asinh]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/asinh
204+
205+
[@stdlib/math/base/special/atand]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/atand
206+
193207
<!-- </related-links> -->
194208

195209
</section>

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

+14
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,14 @@ int main( void ) {
157157

158158
<section class="related">
159159

160+
* * *
161+
162+
## See Also
163+
164+
- <span class="package-name">[`@stdlib/math/base/special/atan`][@stdlib/math/base/special/atan]</span><span class="delimiter">: </span><span class="description">compute the arctangent of a double-precision floating-point number.</span>
165+
- <span class="package-name">[`@stdlib/math/base/special/atanh`][@stdlib/math/base/special/atanh]</span><span class="delimiter">: </span><span class="description">compute the hyperbolic arctangent of a double-precision floating-point number.</span>
166+
- <span class="package-name">[`@stdlib/math/base/special/acosd`][@stdlib/math/base/special/acosd]</span><span class="delimiter">: </span><span class="description">compute the arccosine (in degrees) of a double-precision floating-point number.</span>
167+
160168
</section>
161169

162170
<!-- /.related -->
@@ -169,6 +177,12 @@ int main( void ) {
169177

170178
<!-- <related-links> -->
171179

180+
[@stdlib/math/base/special/atan]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/atan
181+
182+
[@stdlib/math/base/special/atanh]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/atanh
183+
184+
[@stdlib/math/base/special/acosd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/acosd
185+
172186
<!-- </related-links> -->
173187

174188
</section>

lib/node_modules/@stdlib/math/strided/ops/add-by/README.md

+18
Original file line numberDiff line numberDiff line change
@@ -241,6 +241,14 @@ console.log( z );
241241

242242
<section class="related">
243243

244+
* * *
245+
246+
## See Also
247+
248+
- <span class="package-name">[`@stdlib/math/strided/ops/add`][@stdlib/math/strided/ops/add]</span><span class="delimiter">: </span><span class="description">element-wise addition of two strided arrays.</span>
249+
- <span class="package-name">[`@stdlib/math/strided/ops/mul-by`][@stdlib/math/strided/ops/mul-by]</span><span class="delimiter">: </span><span class="description">element-wise multiplication of two strided arrays via a callback function.</span>
250+
- <span class="package-name">[`@stdlib/math/strided/ops/sub-by`][@stdlib/math/strided/ops/sub-by]</span><span class="delimiter">: </span><span class="description">element-wise subtraction of two strided arrays via a callback function.</span>
251+
244252
</section>
245253

246254
<!-- /.related -->
@@ -255,6 +263,16 @@ console.log( z );
255263

256264
[@stdlib/math/base/ops/add]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/add
257265

266+
<!-- <related-links> -->
267+
268+
[@stdlib/math/strided/ops/add]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/strided/ops/add
269+
270+
[@stdlib/math/strided/ops/mul-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/strided/ops/mul-by
271+
272+
[@stdlib/math/strided/ops/sub-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/strided/ops/sub-by
273+
274+
<!-- </related-links> -->
275+
258276
</section>
259277

260278
<!-- /.links -->

lib/node_modules/@stdlib/math/strided/special/cbrt-by/README.md

+12
Original file line numberDiff line numberDiff line change
@@ -229,6 +229,12 @@ console.log( y );
229229

230230
<section class="related">
231231

232+
* * *
233+
234+
## See Also
235+
236+
- <span class="package-name">[`@stdlib/math/strided/special/cbrt`][@stdlib/math/strided/special/cbrt]</span><span class="delimiter">: </span><span class="description">compute the cube root of each element in a strided array.</span>
237+
232238
</section>
233239

234240
<!-- /.related -->
@@ -243,6 +249,12 @@ console.log( y );
243249

244250
[@stdlib/math/base/special/cbrt]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/cbrt
245251

252+
<!-- <related-links> -->
253+
254+
[@stdlib/math/strided/special/cbrt]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/strided/special/cbrt
255+
256+
<!-- </related-links> -->
257+
246258
</section>
247259

248260
<!-- /.links -->

lib/node_modules/@stdlib/random/array/bernoulli/README.md

+7
Original file line numberDiff line numberDiff line change
@@ -357,6 +357,7 @@ logEach( '%f', x4 );
357357
## See Also
358358

359359
- <span class="package-name">[`@stdlib/random/base/bernoulli`][@stdlib/random/base/bernoulli]</span><span class="delimiter">: </span><span class="description">Bernoulli distributed pseudorandom numbers.</span>
360+
- <span class="package-name">[`@stdlib/random/strided/bernoulli`][@stdlib/random/strided/bernoulli]</span><span class="delimiter">: </span><span class="description">fill a strided array with pseudorandom numbers drawn from a Bernoulli distribution.</span>
360361

361362
</section>
362363

@@ -374,6 +375,12 @@ logEach( '%f', x4 );
374375

375376
[@stdlib/array/float64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/float64
376377

378+
<!-- <related-links> -->
379+
380+
[@stdlib/random/strided/bernoulli]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/strided/bernoulli
381+
382+
<!-- </related-links> -->
383+
377384
</section>
378385

379386
<!-- /.links -->

lib/node_modules/@stdlib/string/base/ends-with/README.md

+12
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,12 @@ bool = endsWith( str, 'fair', -34 );
128128

129129
<section class="related">
130130

131+
* * *
132+
133+
## See Also
134+
135+
- <span class="package-name">[`@stdlib/string/base/starts-with`][@stdlib/string/base/starts-with]</span><span class="delimiter">: </span><span class="description">test if a string starts with the characters of another string.</span>
136+
131137
</section>
132138

133139
<!-- /.related -->
@@ -138,6 +144,12 @@ bool = endsWith( str, 'fair', -34 );
138144

139145
[mdn-string-endswith]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/endsWith
140146

147+
<!-- <related-links> -->
148+
149+
[@stdlib/string/base/starts-with]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/starts-with
150+
151+
<!-- </related-links> -->
152+
141153
</section>
142154

143155
<!-- /.links -->

lib/node_modules/@stdlib/string/base/first/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,8 @@ str = first( 'The Last of the Mohicans', 5 );
8585

8686
- <span class="package-name">[`@stdlib/string/base/first-code-point`][@stdlib/string/base/first-code-point]</span><span class="delimiter">: </span><span class="description">return the first Unicode code point of a string.</span>
8787
- <span class="package-name">[`@stdlib/string/base/first-grapheme-cluster`][@stdlib/string/base/first-grapheme-cluster]</span><span class="delimiter">: </span><span class="description">return the first grapheme cluster (i.e., user-perceived character) of a string.</span>
88+
- <span class="package-name">[`@stdlib/string/base/last`][@stdlib/string/base/last]</span><span class="delimiter">: </span><span class="description">return the last UTF-16 code unit of a string.</span>
89+
- <span class="package-name">[`@stdlib/string/base/remove-first`][@stdlib/string/base/remove-first]</span><span class="delimiter">: </span><span class="description">remove the first UTF-16 code unit of a string.</span>
8890
- <span class="package-name">[`@stdlib/string/first`][@stdlib/string/first]</span><span class="delimiter">: </span><span class="description">return the first character(s) of a string.</span>
8991

9092
</section>
@@ -101,6 +103,10 @@ str = first( 'The Last of the Mohicans', 5 );
101103

102104
[@stdlib/string/base/first-grapheme-cluster]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/first-grapheme-cluster
103105

106+
[@stdlib/string/base/last]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/last
107+
108+
[@stdlib/string/base/remove-first]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/remove-first
109+
104110
[@stdlib/string/first]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/first
105111

106112
<!-- </related-links> -->

lib/node_modules/@stdlib/string/base/replace-before-last/README.md

+18
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,14 @@ out = replaceBeforeLast( str, 'xyz', 'foo', str.length );
129129

130130
<section class="related">
131131

132+
* * *
133+
134+
## See Also
135+
136+
- <span class="package-name">[`@stdlib/string/base/replace-after-last`][@stdlib/string/base/replace-after-last]</span><span class="delimiter">: </span><span class="description">replace the substring after the last occurrence of a specified search string.</span>
137+
- <span class="package-name">[`@stdlib/string/base/replace-after`][@stdlib/string/base/replace-after]</span><span class="delimiter">: </span><span class="description">replace the substring after the first occurrence of a specified search string.</span>
138+
- <span class="package-name">[`@stdlib/string/base/replace-before`][@stdlib/string/base/replace-before]</span><span class="delimiter">: </span><span class="description">replace the substring before the first occurrence of a specified search string.</span>
139+
132140
</section>
133141

134142
<!-- /.related -->
@@ -137,6 +145,16 @@ out = replaceBeforeLast( str, 'xyz', 'foo', str.length );
137145

138146
<section class="links">
139147

148+
<!-- <related-links> -->
149+
150+
[@stdlib/string/base/replace-after-last]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/replace-after-last
151+
152+
[@stdlib/string/base/replace-after]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/replace-after
153+
154+
[@stdlib/string/base/replace-before]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/replace-before
155+
156+
<!-- </related-links> -->
157+
140158
</section>
141159

142160
<!-- /.links -->

lib/node_modules/@stdlib/string/base/reverse/README.md

+15
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,13 @@ str = reverse( 'The Last of the Mohicans' );
7676

7777
<section class="related">
7878

79+
* * *
80+
81+
## See Also
82+
83+
- <span class="package-name">[`@stdlib/string/base/reverse-code-points`][@stdlib/string/base/reverse-code-points]</span><span class="delimiter">: </span><span class="description">reverse the Unicode code points of a string.</span>
84+
- <span class="package-name">[`@stdlib/string/base/reverse-grapheme-clusters`][@stdlib/string/base/reverse-grapheme-clusters]</span><span class="delimiter">: </span><span class="description">reverse the grapheme clusters (i.e., user-perceived characters) of a string.</span>
85+
7986
</section>
8087

8188
<!-- /.related -->
@@ -84,6 +91,14 @@ str = reverse( 'The Last of the Mohicans' );
8491

8592
<section class="links">
8693

94+
<!-- <related-links> -->
95+
96+
[@stdlib/string/base/reverse-code-points]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/reverse-code-points
97+
98+
[@stdlib/string/base/reverse-grapheme-clusters]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/reverse-grapheme-clusters
99+
100+
<!-- </related-links> -->
101+
87102
</section>
88103

89104
<!-- /.links -->

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

+3
Original file line numberDiff line numberDiff line change
@@ -203,6 +203,7 @@ b
203203
## See Also
204204

205205
- <span class="package-name">[`@stdlib/string/remove-first`][@stdlib/string/remove-first]</span><span class="delimiter">: </span><span class="description">remove the first character(s) of a string.</span>
206+
- <span class="package-name">[`@stdlib/string/last`][@stdlib/string/last]</span><span class="delimiter">: </span><span class="description">return the last character(s) of a string.</span>
206207

207208
</section>
208209

@@ -220,6 +221,8 @@ b
220221

221222
[@stdlib/string/remove-first]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/remove-first
222223

224+
[@stdlib/string/last]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/last
225+
223226
<!-- </related-links> -->
224227

225228
</section>

lib/node_modules/@stdlib/utils/any-own-by/README.md

+17
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,15 @@ bool = anyOwnBy( obj, threshold );
185185

186186
<section class="related">
187187

188+
* * *
189+
190+
## See Also
191+
192+
- <span class="package-name">[`@stdlib/utils/any-by`][@stdlib/utils/any-by]</span><span class="delimiter">: </span><span class="description">test whether at least one element in a collection passes a test implemented by a predicate function.</span>
193+
- <span class="package-name">[`@stdlib/utils/any-in-by`][@stdlib/utils/any-in-by]</span><span class="delimiter">: </span><span class="description">test whether at least one property in an object passes a test implemented by a predicate function.</span>
194+
- <span class="package-name">[`@stdlib/utils/every-own-by`][@stdlib/utils/every-own-by]</span><span class="delimiter">: </span><span class="description">test whether all own properties of an object pass a test implemented by a predicate function.</span>
195+
- <span class="package-name">[`@stdlib/utils/some-own-by`][@stdlib/utils/some-own-by]</span><span class="delimiter">: </span><span class="description">test whether some `own` properties of a provided object satisfy a predicate function for at least `n` properties.</span>
196+
188197
</section>
189198

190199
<!-- /.related -->
@@ -197,6 +206,14 @@ bool = anyOwnBy( obj, threshold );
197206

198207
<!-- <related-links> -->
199208

209+
[@stdlib/utils/any-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/any-by
210+
211+
[@stdlib/utils/any-in-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/any-in-by
212+
213+
[@stdlib/utils/every-own-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/every-own-by
214+
215+
[@stdlib/utils/some-own-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/some-own-by
216+
200217
<!-- </related-links> -->
201218

202219
</section>

lib/node_modules/@stdlib/utils/every-own-by/README.md

+20
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,16 @@ var bool = everyOwnBy( obj, isPositive );
185185

186186
<section class="related">
187187

188+
* * *
189+
190+
## See Also
191+
192+
- <span class="package-name">[`@stdlib/utils/any-own-by`][@stdlib/utils/any-own-by]</span><span class="delimiter">: </span><span class="description">test whether whether any 'own' property of a provided object satisfies a predicate function.</span>
193+
- <span class="package-name">[`@stdlib/utils/every-in-by`][@stdlib/utils/every-in-by]</span><span class="delimiter">: </span><span class="description">test whether all properties (own and inherited) of an object pass a test implemented by a predicate function.</span>
194+
- <span class="package-name">[`@stdlib/utils/none-own-by`][@stdlib/utils/none-own-by]</span><span class="delimiter">: </span><span class="description">tests whether every own property of an object fails a test implemented by a predicate function.</span>
195+
- <span class="package-name">[`@stdlib/utils/some-own-by`][@stdlib/utils/some-own-by]</span><span class="delimiter">: </span><span class="description">test whether some `own` properties of a provided object satisfy a predicate function for at least `n` properties.</span>
196+
- <span class="package-name">[`@stdlib/utils/every-by`][@stdlib/utils/every-by]</span><span class="delimiter">: </span><span class="description">test whether all elements in a collection pass a test implemented by a predicate function.</span>
197+
188198
</section>
189199

190200
<!-- /.related -->
@@ -197,6 +207,16 @@ var bool = everyOwnBy( obj, isPositive );
197207

198208
<!-- <related-links> -->
199209

210+
[@stdlib/utils/any-own-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/any-own-by
211+
212+
[@stdlib/utils/every-in-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/every-in-by
213+
214+
[@stdlib/utils/none-own-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/none-own-by
215+
216+
[@stdlib/utils/some-own-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/some-own-by
217+
218+
[@stdlib/utils/every-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/every-by
219+
200220
<!-- </related-links> -->
201221

202222
</section>

0 commit comments

Comments
 (0)