Skip to content

Commit 7d6450c

Browse files
stdlib-botstdlib-bot
authored
docs: update related packages sections
PR-URL: stdlib-js#4186 Reviewed-by: Philipp Burckhardt <[email protected]>
1 parent b7867cb commit 7d6450c

File tree

9 files changed

+128
-0
lines changed

9 files changed

+128
-0
lines changed

‎lib/node_modules/@stdlib/array/base/zeros/README.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,17 @@ console.log( arr );
103103

104104
<section class="related">
105105

106+
* * *
107+
108+
## See Also
109+
110+
- <span class="package-name">[`@stdlib/array/base/ones`][@stdlib/array/base/ones]</span><span class="delimiter">: </span><span class="description">create a generic array filled with ones.</span>
111+
- <span class="package-name">[`@stdlib/array/base/zeros2d`][@stdlib/array/base/zeros2d]</span><span class="delimiter">: </span><span class="description">create a zero-filled two-dimensional nested array.</span>
112+
- <span class="package-name">[`@stdlib/array/base/zeros3d`][@stdlib/array/base/zeros3d]</span><span class="delimiter">: </span><span class="description">create a zero-filled three-dimensional nested array.</span>
113+
- <span class="package-name">[`@stdlib/array/base/zeros4d`][@stdlib/array/base/zeros4d]</span><span class="delimiter">: </span><span class="description">create a zero-filled four-dimensional nested array.</span>
114+
- <span class="package-name">[`@stdlib/array/base/zeros5d`][@stdlib/array/base/zeros5d]</span><span class="delimiter">: </span><span class="description">create a zero-filled five-dimensional nested array.</span>
115+
- <span class="package-name">[`@stdlib/array/base/zerosnd`][@stdlib/array/base/zerosnd]</span><span class="delimiter">: </span><span class="description">create a zero-filled n-dimensional nested array.</span>
116+
106117
</section>
107118

108119
<!-- /.related -->
@@ -111,6 +122,22 @@ console.log( arr );
111122

112123
<section class="links">
113124

125+
<!-- <related-links> -->
126+
127+
[@stdlib/array/base/ones]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/ones
128+
129+
[@stdlib/array/base/zeros2d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/zeros2d
130+
131+
[@stdlib/array/base/zeros3d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/zeros3d
132+
133+
[@stdlib/array/base/zeros4d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/zeros4d
134+
135+
[@stdlib/array/base/zeros5d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/zeros5d
136+
137+
[@stdlib/array/base/zerosnd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/zerosnd
138+
139+
<!-- </related-links> -->
140+
114141
</section>
115142

116143
<!-- /.links -->

‎lib/node_modules/@stdlib/assert/is-absolute-http-uri/README.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,12 @@ false
185185

186186
<section class="related">
187187

188+
* * *
189+
190+
## See Also
191+
192+
- <span class="package-name">[`@stdlib/assert/is-absolute-uri`][@stdlib/assert/is-absolute-uri]</span><span class="delimiter">: </span><span class="description">test whether a value is an absolute URI.</span>
193+
188194
</section>
189195

190196
<!-- /.related -->
@@ -201,6 +207,12 @@ false
201207

202208
[standard-streams]: https://en.wikipedia.org/wiki/Standard_streams
203209

210+
<!-- <related-links> -->
211+
212+
[@stdlib/assert/is-absolute-uri]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-absolute-uri
213+
214+
<!-- </related-links> -->
215+
204216
</section>
205217

206218
<!-- /.links -->

‎lib/node_modules/@stdlib/assert/is-absolute-uri/README.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,12 @@ false
185185

186186
<section class="related">
187187

188+
* * *
189+
190+
## See Also
191+
192+
- <span class="package-name">[`@stdlib/assert/is-relative-uri`][@stdlib/assert/is-relative-uri]</span><span class="delimiter">: </span><span class="description">test whether a value is a relative URI.</span>
193+
188194
</section>
189195

190196
<!-- /.related -->
@@ -201,6 +207,12 @@ false
201207

202208
[standard-streams]: https://en.wikipedia.org/wiki/Standard_streams
203209

210+
<!-- <related-links> -->
211+
212+
[@stdlib/assert/is-relative-uri]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-relative-uri
213+
214+
<!-- </related-links> -->
215+
204216
</section>
205217

206218
<!-- /.links -->

‎lib/node_modules/@stdlib/assert/is-equal-array/README.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,13 @@ out = isEqualArray( x, y );
9191

9292
<section class="related">
9393

94+
* * *
95+
96+
## See Also
97+
98+
- <span class="package-name">[`@stdlib/assert/is-array`][@stdlib/assert/is-array]</span><span class="delimiter">: </span><span class="description">test if a value is an array.</span>
99+
- <span class="package-name">[`@stdlib/assert/is-same-array`][@stdlib/assert/is-same-array]</span><span class="delimiter">: </span><span class="description">test if two arguments are both generic arrays and have the same values.</span>
100+
94101
</section>
95102

96103
<!-- /.related -->
@@ -101,6 +108,10 @@ out = isEqualArray( x, y );
101108

102109
<!-- <related-links> -->
103110

111+
[@stdlib/assert/is-array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-array
112+
113+
[@stdlib/assert/is-same-array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-same-array
114+
104115
<!-- </related-links> -->
105116

106117
</section>

‎lib/node_modules/@stdlib/assert/is-startcase/README.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,14 @@ true
169169

170170
<section class="related">
171171

172+
* * *
173+
174+
## See Also
175+
176+
- <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>
177+
178+
</section>
179+
172180
<!-- /.related -->
173181

174182
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
@@ -181,6 +189,8 @@ true
181189

182190
<!-- <related-links> -->
183191

192+
[@stdlib/assert/is-string]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-string
193+
184194
<!-- </related-links> -->
185195

186196
</section>

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

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,14 @@ Macro for the mask for excluding the sign bit of a [single-precision floating-po
136136

137137
<section class="related">
138138

139+
* * *
140+
141+
## See Also
142+
143+
- <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>
144+
- <span class="package-name">[`@stdlib/constants/float32/sign-mask`][@stdlib/constants/float32/sign-mask]</span><span class="delimiter">: </span><span class="description">mask for the sign bit of a single-precision floating-point number.</span>
145+
- <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>
146+
139147
</section>
140148

141149
<!-- /.related -->
@@ -146,6 +154,16 @@ Macro for the mask for excluding the sign bit of a [single-precision floating-po
146154

147155
[ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985
148156

157+
<!-- <related-links> -->
158+
159+
[@stdlib/constants/float32/exponent-mask]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/exponent-mask
160+
161+
[@stdlib/constants/float32/sign-mask]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/sign-mask
162+
163+
[@stdlib/constants/float32/significand-mask]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/significand-mask
164+
165+
<!-- </related-links> -->
166+
149167
</section>
150168

151169
<!-- /.links -->

‎lib/node_modules/@stdlib/math/base/special/minmaxabsn/README.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,14 @@ for ( i = 0; i < 100; i++ ) {
138138

139139
<section class="related">
140140

141+
* * *
142+
143+
## See Also
144+
145+
- <span class="package-name">[`@stdlib/math/base/special/maxabsn`][@stdlib/math/base/special/maxabsn]</span><span class="delimiter">: </span><span class="description">return the maximum absolute value.</span>
146+
- <span class="package-name">[`@stdlib/math/base/special/minabsn`][@stdlib/math/base/special/minabsn]</span><span class="delimiter">: </span><span class="description">return the minimum absolute value.</span>
147+
- <span class="package-name">[`@stdlib/math/base/special/minmaxn`][@stdlib/math/base/special/minmaxn]</span><span class="delimiter">: </span><span class="description">return the minimum and maximum values.</span>
148+
141149
</section>
142150

143151
<!-- /.related -->
@@ -148,6 +156,12 @@ for ( i = 0; i < 100; i++ ) {
148156

149157
<!-- <related-links> -->
150158

159+
[@stdlib/math/base/special/maxabsn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/maxabsn
160+
161+
[@stdlib/math/base/special/minabsn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/minabsn
162+
163+
[@stdlib/math/base/special/minmaxn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/minmaxn
164+
151165
<!-- </related-links> -->
152166

153167
</section>

‎lib/node_modules/@stdlib/strided/base/min-view-buffer-index/README.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,12 @@ int main( void ) {
204204

205205
<section class="related">
206206

207+
* * *
208+
209+
## See Also
210+
211+
- <span class="package-name">[`@stdlib/strided/base/offset-view`][@stdlib/strided/base/offset-view]</span><span class="delimiter">: </span><span class="description">return a typed array view having the same data type as a provided input typed array and starting at a specified index offset.</span>
212+
207213
</section>
208214

209215
<!-- /.related -->
@@ -212,6 +218,12 @@ int main( void ) {
212218

213219
<section class="links">
214220

221+
<!-- <related-links> -->
222+
223+
[@stdlib/strided/base/offset-view]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/offset-view
224+
225+
<!-- </related-links> -->
226+
215227
</section>
216228

217229
<!-- /.links -->

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,12 @@ bool = startsWith( str, 'filthy', -10 );
124124

125125
<section class="related">
126126

127+
* * *
128+
129+
## See Also
130+
131+
- <span class="package-name">[`@stdlib/string/base/ends-with`][@stdlib/string/base/ends-with]</span><span class="delimiter">: </span><span class="description">test if a string ends with the characters of another string.</span>
132+
127133
</section>
128134

129135
<!-- /.related -->
@@ -134,6 +140,12 @@ bool = startsWith( str, 'filthy', -10 );
134140

135141
[mdn-string-startswith]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/startsWith
136142

143+
<!-- <related-links> -->
144+
145+
[@stdlib/string/base/ends-with]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/ends-with
146+
147+
<!-- </related-links> -->
148+
137149
</section>
138150

139151
<!-- /.links -->

0 commit comments

Comments
 (0)