Skip to content

Commit 8684eb4

Browse files
stdlib-botkgryte
andauthored
docs: update related packages sections
PR-URL: #4114 Co-authored-by: Athan Reines <[email protected]> Reviewed-by: Athan Reines <[email protected]>
1 parent fa0ac0e commit 8684eb4

File tree

7 files changed

+85
-2
lines changed

7 files changed

+85
-2
lines changed

lib/node_modules/@stdlib/blas/base/ccopy/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -353,7 +353,7 @@ int main( void ) {
353353
354354
## See Also
355355
356-
- <span class="package-name">[`@stdlib/blas/base/cswap`][@stdlib/blas/base/cswap]</span><span class="delimiter">: </span><span class="description">interchanges two complex single-precision floating-point vectors.</span>
356+
- <span class="package-name">[`@stdlib/blas/base/cswap`][@stdlib/blas/base/cswap]</span><span class="delimiter">: </span><span class="description">interchange two complex single-precision floating-point vectors.</span>
357357
358358
</section>
359359

lib/node_modules/@stdlib/blas/sswap/README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,14 @@ console.log( ndarray2array( y ) );
145145

146146
<section class="related">
147147

148+
* * *
149+
150+
## See Also
151+
152+
- <span class="package-name">[`@stdlib/blas/base/sswap`][@stdlib/blas/base/sswap]</span><span class="delimiter">: </span><span class="description">interchange two single-precision floating-point vectors.</span>
153+
- <span class="package-name">[`@stdlib/blas/dswap`][@stdlib/blas/dswap]</span><span class="delimiter">: </span><span class="description">interchange two double-precision floating-point vectors.</span>
154+
- <span class="package-name">[`@stdlib/blas/gswap`][@stdlib/blas/gswap]</span><span class="delimiter">: </span><span class="description">interchange two vectors.</span>
155+
148156
</section>
149157

150158
<!-- /.related -->
@@ -161,6 +169,14 @@ console.log( ndarray2array( y ) );
161169

162170
[@stdlib/blas/base/sswap]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/sswap
163171

172+
<!-- <related-links> -->
173+
174+
[@stdlib/blas/dswap]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/dswap
175+
176+
[@stdlib/blas/gswap]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/gswap
177+
178+
<!-- </related-links> -->
179+
164180
</section>
165181

166182
<!-- /.links -->

lib/node_modules/@stdlib/iter/strided-by/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,7 @@ while ( true ) {
240240

241241
## See Also
242242

243-
- <span class="package-name">[`@stdlib/iter/advance`][@stdlib/iter/advance]</span><span class="delimiter">: </span><span class="description">advances an iterator.</span>
243+
- <span class="package-name">[`@stdlib/iter/advance`][@stdlib/iter/advance]</span><span class="delimiter">: </span><span class="description">advance an iterator.</span>
244244
- <span class="package-name">[`@stdlib/iter/nth`][@stdlib/iter/nth]</span><span class="delimiter">: </span><span class="description">return the nth iterated value.</span>
245245
- <span class="package-name">[`@stdlib/iter/strided`][@stdlib/iter/strided]</span><span class="delimiter">: </span><span class="description">create an iterator which steps by a specified amount.</span>
246246

lib/node_modules/@stdlib/ndarray/ndarraylike2ndarray/README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,15 @@ console.log( 'order: %s', out.order );
115115

116116
<section class="related">
117117

118+
* * *
119+
120+
## See Also
121+
122+
- <span class="package-name">[`@stdlib/ndarray/array`][@stdlib/ndarray/array]</span><span class="delimiter">: </span><span class="description">multidimensional arrays.</span>
123+
- <span class="package-name">[`@stdlib/ndarray/ctor`][@stdlib/ndarray/ctor]</span><span class="delimiter">: </span><span class="description">multidimensional array constructor.</span>
124+
- <span class="package-name">[`@stdlib/ndarray/empty-like`][@stdlib/ndarray/empty-like]</span><span class="delimiter">: </span><span class="description">create an uninitialized ndarray having the same shape and data type as a provided ndarray.</span>
125+
- <span class="package-name">[`@stdlib/ndarray/zeros-like`][@stdlib/ndarray/zeros-like]</span><span class="delimiter">: </span><span class="description">create a zero-filled ndarray having the same shape and data type as a provided ndarray.</span>
126+
118127
</section>
119128

120129
<!-- /.related -->
@@ -125,6 +134,16 @@ console.log( 'order: %s', out.order );
125134

126135
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor
127136

137+
<!-- <related-links> -->
138+
139+
[@stdlib/ndarray/array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/array
140+
141+
[@stdlib/ndarray/empty-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/empty-like
142+
143+
[@stdlib/ndarray/zeros-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/zeros-like
144+
145+
<!-- </related-links> -->
146+
128147
</section>
129148

130149
<!-- /.links -->

lib/node_modules/@stdlib/strided/base/reinterpret-complex64/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,13 @@ var im = imag( z );
144144

145145
<section class="related">
146146

147+
* * *
148+
149+
## See Also
150+
151+
- <span class="package-name">[`@stdlib/strided/base/reinterpret-complex`][@stdlib/strided/base/reinterpret-complex]</span><span class="delimiter">: </span><span class="description">reinterpret a complex-valued floating-point array as a real-valued floating-point array having the same precision.</span>
152+
- <span class="package-name">[`@stdlib/strided/base/reinterpret-complex128`][@stdlib/strided/base/reinterpret-complex128]</span><span class="delimiter">: </span><span class="description">reinterpret a Complex128Array as a Float64Array.</span>
153+
147154
</section>
148155

149156
<!-- /.related -->
@@ -156,6 +163,14 @@ var im = imag( z );
156163

157164
[@stdlib/array/float32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/float32
158165

166+
<!-- <related-links> -->
167+
168+
[@stdlib/strided/base/reinterpret-complex]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/reinterpret-complex
169+
170+
[@stdlib/strided/base/reinterpret-complex128]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/reinterpret-complex128
171+
172+
<!-- </related-links> -->
173+
159174
</section>
160175

161176
<!-- /.links -->

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

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,13 @@ out = invcase( str );
8989

9090
<section class="related">
9191

92+
* * *
93+
94+
## See Also
95+
96+
- <span class="package-name">[`@stdlib/string/base/lowercase`][@stdlib/string/base/lowercase]</span><span class="delimiter">: </span><span class="description">convert a string to lowercase.</span>
97+
- <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>
98+
9299
</section>
93100

94101
<!-- /.related -->
@@ -97,6 +104,14 @@ out = invcase( str );
97104

98105
<section class="links">
99106

107+
<!-- <related-links> -->
108+
109+
[@stdlib/string/base/lowercase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/lowercase
110+
111+
[@stdlib/string/base/uppercase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/uppercase
112+
113+
<!-- </related-links> -->
114+
100115
</section>
101116

102117
<!-- /.links -->

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

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,14 @@ str = removeFirst( 'The Last of the Mohicans', 5 );
7979

8080
<section class="related">
8181

82+
* * *
83+
84+
## See Also
85+
86+
- <span class="package-name">[`@stdlib/string/base/remove-first-code-point`][@stdlib/string/base/remove-first-code-point]</span><span class="delimiter">: </span><span class="description">remove the first Unicode code point of a string.</span>
87+
- <span class="package-name">[`@stdlib/string/base/remove-first-grapheme-cluster`][@stdlib/string/base/remove-first-grapheme-cluster]</span><span class="delimiter">: </span><span class="description">remove the first grapheme cluster (i.e., user-perceived character) of a string.</span>
88+
- <span class="package-name">[`@stdlib/string/base/remove-last`][@stdlib/string/base/remove-last]</span><span class="delimiter">: </span><span class="description">remove the last UTF-16 code unit of a string.</span>
89+
8290
</section>
8391

8492
<!-- /.related -->
@@ -87,6 +95,16 @@ str = removeFirst( 'The Last of the Mohicans', 5 );
8795

8896
<section class="links">
8997

98+
<!-- <related-links> -->
99+
100+
[@stdlib/string/base/remove-first-code-point]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/remove-first-code-point
101+
102+
[@stdlib/string/base/remove-first-grapheme-cluster]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/remove-first-grapheme-cluster
103+
104+
[@stdlib/string/base/remove-last]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/remove-last
105+
106+
<!-- </related-links> -->
107+
90108
</section>
91109

92110
<!-- /.links -->

0 commit comments

Comments
 (0)