Skip to content

Commit 9ef09e2

Browse files
stdlib-botstdlib-bot
authored
docs: update related packages sections
PR-URL: stdlib-js#2248 Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
1 parent 40bf4fa commit 9ef09e2

8 files changed

Lines changed: 144 additions & 0 deletions

File tree

‎lib/node_modules/@stdlib/array/base/flatten-by/README.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,12 @@ out = flattenBy( x, [ 2, 2, 1, 2, 2 ], true, fcn );
200200

201201
<section class="related">
202202

203+
* * *
204+
205+
## See Also
206+
207+
- <span class="package-name">[`@stdlib/array/base/flatten`][@stdlib/array/base/flatten]</span><span class="delimiter">: </span><span class="description">flatten an n-dimensional nested array.</span>
208+
203209
</section>
204210

205211
<!-- /.related -->
@@ -208,6 +214,12 @@ out = flattenBy( x, [ 2, 2, 1, 2, 2 ], true, fcn );
208214

209215
<section class="links">
210216

217+
<!-- <related-links> -->
218+
219+
[@stdlib/array/base/flatten]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten
220+
221+
<!-- </related-links> -->
222+
211223
</section>
212224

213225
<!-- /.links -->

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,12 @@ out = flatten3d( x, [ 4, 2, 2 ], true );
139139

140140
<section class="related">
141141

142+
* * *
143+
144+
## See Also
145+
146+
- <span class="package-name">[`@stdlib/array/base/flatten3d-by`][@stdlib/array/base/flatten3d-by]</span><span class="delimiter">: </span><span class="description">flatten a three-dimensional nested array according to a callback function.</span>
147+
142148
</section>
143149

144150
<!-- /.related -->
@@ -147,6 +153,12 @@ out = flatten3d( x, [ 4, 2, 2 ], true );
147153

148154
<section class="links">
149155

156+
<!-- <related-links> -->
157+
158+
[@stdlib/array/base/flatten3d-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten3d-by
159+
160+
<!-- </related-links> -->
161+
150162
</section>
151163

152164
<!-- /.links -->

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

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,14 @@ console.log( y );
9797

9898
<section class="related">
9999

100+
* * *
101+
102+
## See Also
103+
104+
- <span class="package-name">[`@stdlib/array/base/fliplr3d`][@stdlib/array/base/fliplr3d]</span><span class="delimiter">: </span><span class="description">reverse the order of elements along the last dimension of a three-dimensional nested input array.</span>
105+
- <span class="package-name">[`@stdlib/array/base/fliplr4d`][@stdlib/array/base/fliplr4d]</span><span class="delimiter">: </span><span class="description">reverse the order of elements along the last dimension of a four-dimensional nested input array.</span>
106+
- <span class="package-name">[`@stdlib/array/base/fliplr5d`][@stdlib/array/base/fliplr5d]</span><span class="delimiter">: </span><span class="description">reverse the order of elements along the last dimension of a five-dimensional nested input array.</span>
107+
100108
</section>
101109

102110
<!-- /.related -->
@@ -105,6 +113,16 @@ console.log( y );
105113

106114
<section class="links">
107115

116+
<!-- <related-links> -->
117+
118+
[@stdlib/array/base/fliplr3d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/fliplr3d
119+
120+
[@stdlib/array/base/fliplr4d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/fliplr4d
121+
122+
[@stdlib/array/base/fliplr5d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/fliplr5d
123+
124+
<!-- </related-links> -->
125+
108126
</section>
109127

110128
<!-- /.links -->

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

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,17 @@ out = onesnd( [ 1, 1, 1, 3 ] );
104104

105105
<section class="related">
106106

107+
* * *
108+
109+
## See Also
110+
111+
- <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>
112+
- <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>
113+
- <span class="package-name">[`@stdlib/array/base/ones2d`][@stdlib/array/base/ones2d]</span><span class="delimiter">: </span><span class="description">create a two-dimensional nested array filled with ones.</span>
114+
- <span class="package-name">[`@stdlib/array/base/ones3d`][@stdlib/array/base/ones3d]</span><span class="delimiter">: </span><span class="description">create a three-dimensional nested array filled with ones.</span>
115+
- <span class="package-name">[`@stdlib/array/base/ones4d`][@stdlib/array/base/ones4d]</span><span class="delimiter">: </span><span class="description">create a four-dimensional nested array filled with ones.</span>
116+
- <span class="package-name">[`@stdlib/array/base/ones5d`][@stdlib/array/base/ones5d]</span><span class="delimiter">: </span><span class="description">create a five-dimensional nested array filled with ones.</span>
117+
107118
</section>
108119

109120
<!-- /.related -->
@@ -112,6 +123,22 @@ out = onesnd( [ 1, 1, 1, 3 ] );
112123

113124
<section class="links">
114125

126+
<!-- <related-links> -->
127+
128+
[@stdlib/array/base/zerosnd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/zerosnd
129+
130+
[@stdlib/array/base/ones]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/ones
131+
132+
[@stdlib/array/base/ones2d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/ones2d
133+
134+
[@stdlib/array/base/ones3d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/ones3d
135+
136+
[@stdlib/array/base/ones4d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/ones4d
137+
138+
[@stdlib/array/base/ones5d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/ones5d
139+
140+
<!-- </related-links> -->
141+
115142
</section>
116143

117144
<!-- /.links -->

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

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,17 @@ out = zerosnd( [ 1, 1, 1, 3 ] );
104104

105105
<section class="related">
106106

107+
* * *
108+
109+
## See Also
110+
111+
- <span class="package-name">[`@stdlib/array/base/zeros`][@stdlib/array/base/zeros]</span><span class="delimiter">: </span><span class="description">create a zero-filled generic array.</span>
112+
- <span class="package-name">[`@stdlib/array/base/onesnd`][@stdlib/array/base/onesnd]</span><span class="delimiter">: </span><span class="description">create an n-dimensional nested array filled with ones.</span>
113+
- <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>
114+
- <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>
115+
- <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>
116+
- <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>
117+
107118
</section>
108119

109120
<!-- /.related -->
@@ -112,6 +123,22 @@ out = zerosnd( [ 1, 1, 1, 3 ] );
112123

113124
<section class="links">
114125

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

117144
<!-- /.links -->

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

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,13 @@ int main( void ) {
160160

161161
<section class="related">
162162

163+
* * *
164+
165+
## See Also
166+
167+
- <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>
168+
- <span class="package-name">[`@stdlib/math/base/special/asindf`][@stdlib/math/base/special/asindf]</span><span class="delimiter">: </span><span class="description">compute the arcsine (in degrees) of a single-precision floating-point number.</span>
169+
163170
</section>
164171

165172
<!-- /.related -->
@@ -170,6 +177,14 @@ int main( void ) {
170177

171178
[arcsine]: https://en.wikipedia.org/wiki/Inverse_trigonometric_functions
172179

180+
<!-- <related-links> -->
181+
182+
[@stdlib/math/base/special/asin]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/asin
183+
184+
[@stdlib/math/base/special/asindf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/asindf
185+
186+
<!-- </related-links> -->
187+
173188
</section>
174189

175190
<!-- /.links -->

‎lib/node_modules/@stdlib/string/base/for-each-code-point-right/README.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,13 @@ forEachCodePointRight( '\uD834\uDD1E', log );
133133

134134
<section class="related">
135135

136+
* * *
137+
138+
## See Also
139+
140+
- <span class="package-name">[`@stdlib/string/base/for-each-code-point`][@stdlib/string/base/for-each-code-point]</span><span class="delimiter">: </span><span class="description">invoke a function for each Unicode code point in a string.</span>
141+
- <span class="package-name">[`@stdlib/string/base/for-each-right`][@stdlib/string/base/for-each-right]</span><span class="delimiter">: </span><span class="description">invoke a function for each UTF-16 code unit in a string, iterating from right to left.</span>
142+
136143
</section>
137144

138145
<!-- /.related -->
@@ -141,6 +148,14 @@ forEachCodePointRight( '\uD834\uDD1E', log );
141148

142149
<section class="links">
143150

151+
<!-- <related-links> -->
152+
153+
[@stdlib/string/base/for-each-code-point]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/for-each-code-point
154+
155+
[@stdlib/string/base/for-each-right]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/for-each-right
156+
157+
<!-- </related-links> -->
158+
144159
</section>
145160

146161
<!-- /.links -->

‎lib/node_modules/@stdlib/string/base/headercase/README.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,14 @@ out = headercase( str );
8484

8585
<section class="related">
8686

87+
* * *
88+
89+
## See Also
90+
91+
- <span class="package-name">[`@stdlib/string/base/camelcase`][@stdlib/string/base/camelcase]</span><span class="delimiter">: </span><span class="description">convert a string to camel case.</span>
92+
- <span class="package-name">[`@stdlib/string/base/pascalcase`][@stdlib/string/base/pascalcase]</span><span class="delimiter">: </span><span class="description">convert a string to Pascal case.</span>
93+
- <span class="package-name">[`@stdlib/string/base/uppercase`][@stdlib/string/base/uppercase]</span><span class="delimiter">: </span><span class="description">convert a string to uppercase.</span>
94+
8795
</section>
8896

8997
<!-- /.related -->
@@ -92,6 +100,16 @@ out = headercase( str );
92100

93101
<section class="links">
94102

103+
<!-- <related-links> -->
104+
105+
[@stdlib/string/base/camelcase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/camelcase
106+
107+
[@stdlib/string/base/pascalcase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/pascalcase
108+
109+
[@stdlib/string/base/uppercase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/uppercase
110+
111+
<!-- </related-links> -->
112+
95113
</section>
96114

97115
<!-- /.links -->

0 commit comments

Comments
 (0)