Skip to content

Commit bc279b5

Browse files
stdlib-botPlaneshifter
stdlib-bot
and
Planeshifter
authored
docs: update related packages sections
PR-URL: #4485 Co-authored-by: Philipp Burckhardt <pburckhardt@outlook.com> Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
1 parent f9d393e commit bc279b5

File tree

5 files changed

+86
-2
lines changed

5 files changed

+86
-2
lines changed

‎lib/node_modules/@stdlib/array/base/ones/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/zeros`][@stdlib/array/base/zeros]</span><span class="delimiter">: </span><span class="description">create a zero-filled generic array.</span>
111+
- <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>
112+
- <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>
113+
- <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>
114+
- <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>
115+
- <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>
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/zeros]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/zeros
128+
129+
[@stdlib/array/base/ones2d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/ones2d
130+
131+
[@stdlib/array/base/ones3d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/ones3d
132+
133+
[@stdlib/array/base/ones4d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/ones4d
134+
135+
[@stdlib/array/base/ones5d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/ones5d
136+
137+
[@stdlib/array/base/onesnd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/onesnd
138+
139+
<!-- </related-links> -->
140+
114141
</section>
115142

116143
<!-- /.links -->

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

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

9696
<section class="related">
9797

98+
* * *
99+
100+
## See Also
101+
102+
- <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>
103+
- <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>
104+
- <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>
105+
- <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>
106+
- <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>
107+
- <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>
108+
98109
</section>
99110

100111
<!-- /.related -->
@@ -103,6 +114,22 @@ out = zeros3d( [ 1, 3, 1 ] );
103114

104115
<section class="links">
105116

117+
<!-- <related-links> -->
118+
119+
[@stdlib/array/base/zeros]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/zeros
120+
121+
[@stdlib/array/base/ones3d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/ones3d
122+
123+
[@stdlib/array/base/zeros2d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/zeros2d
124+
125+
[@stdlib/array/base/zeros4d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/zeros4d
126+
127+
[@stdlib/array/base/zeros5d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/zeros5d
128+
129+
[@stdlib/array/base/zerosnd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/zerosnd
130+
131+
<!-- </related-links> -->
132+
106133
</section>
107134

108135
<!-- /.links -->

‎lib/node_modules/@stdlib/constants/float32/sqrt-half-pi/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ Macro for the square root of the mathematical constant [π][@stdlib/constants/fl
124124

125125
## See Also
126126

127-
- <span class="package-name">[`@stdlib/constants/float32/pi`][@stdlib/constants/float32/pi]</span><span class="delimiter">: </span><span class="description">π.</span>
127+
- <span class="package-name">[`@stdlib/constants/float64/sqrt-half-pi`][@stdlib/constants/float64/sqrt-half-pi]</span><span class="delimiter">: </span><span class="description">square root of 0.5π.</span>
128128

129129
</section>
130130

@@ -134,9 +134,11 @@ Macro for the square root of the mathematical constant [π][@stdlib/constants/fl
134134

135135
<section class="links">
136136

137+
[@stdlib/constants/float32/pi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/pi
138+
137139
<!-- <related-links> -->
138140

139-
[@stdlib/constants/float32/pi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/pi
141+
[@stdlib/constants/float64/sqrt-half-pi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float64/sqrt-half-pi
140142

141143
<!-- </related-links> -->
142144

‎lib/node_modules/@stdlib/slice/base/seq2multislice/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,13 @@ s = seq2multislice( 'foo,bar', [ 10, 10 ], false );
174174

175175
<section class="related">
176176

177+
* * *
178+
179+
## See Also
180+
181+
- <span class="package-name">[`@stdlib/slice/base/seq2slice`][@stdlib/slice/base/seq2slice]</span><span class="delimiter">: </span><span class="description">convert a subsequence string to a Slice object.</span>
182+
- <span class="package-name">[`@stdlib/slice/base/sargs2multislice`][@stdlib/slice/base/sargs2multislice]</span><span class="delimiter">: </span><span class="description">create a MultiSlice object from a comma-separated list of string-serialized MultiSlice constructor arguments.</span>
183+
177184
</section>
178185

179186
<!-- /.related -->
@@ -186,6 +193,12 @@ s = seq2multislice( 'foo,bar', [ 10, 10 ], false );
186193

187194
[@stdlib/slice/base/seq2slice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/slice/base/seq2slice
188195

196+
<!-- <related-links> -->
197+
198+
[@stdlib/slice/base/sargs2multislice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/slice/base/sargs2multislice
199+
200+
<!-- </related-links> -->
201+
189202
</section>
190203

191204
<!-- /.links -->

‎lib/node_modules/@stdlib/strided/base/reinterpret-complex/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-complex128`][@stdlib/strided/base/reinterpret-complex128]</span><span class="delimiter">: </span><span class="description">reinterpret a Complex128Array as a Float64Array.</span>
152+
- <span class="package-name">[`@stdlib/strided/base/reinterpret-complex64`][@stdlib/strided/base/reinterpret-complex64]</span><span class="delimiter">: </span><span class="description">reinterpret a Complex64Array as a Float32Array.</span>
153+
147154
</section>
148155

149156
<!-- /.related -->
@@ -152,6 +159,14 @@ var im = imag( z );
152159

153160
<section class="links">
154161

162+
<!-- <related-links> -->
163+
164+
[@stdlib/strided/base/reinterpret-complex128]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/reinterpret-complex128
165+
166+
[@stdlib/strided/base/reinterpret-complex64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/reinterpret-complex64
167+
168+
<!-- </related-links> -->
169+
155170
</section>
156171

157172
<!-- /.links -->

0 commit comments

Comments
 (0)