Skip to content

Commit 6b00ddc

Browse files
committed
Populate "See Also" sections
1 parent 464a3f7 commit 6b00ddc

File tree

104 files changed

+1494
-2
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

104 files changed

+1494
-2
lines changed

lib/node_modules/@stdlib/constants/array/max-array-length/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,12 @@ try {
112112

113113
<section class="related">
114114

115+
* * *
116+
117+
## See Also
118+
119+
- [`@stdlib/constants/array/max-typed-array-length`][@stdlib/constants/array/max-typed-array-length]: maximum length for a typed array.
120+
115121
</section>
116122

117123
<!-- /.related -->
@@ -120,6 +126,12 @@ try {
120126

121127
<section class="links">
122128

129+
<!-- <related-links> -->
130+
131+
[@stdlib/constants/array/max-typed-array-length]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/array/max-typed-array-length
132+
133+
<!-- </related-links> -->
134+
123135
</section>
124136

125137
<!-- /.links -->

lib/node_modules/@stdlib/constants/array/max-typed-array-length/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,12 @@ try {
116116

117117
<section class="related">
118118

119+
* * *
120+
121+
## See Also
122+
123+
- [`@stdlib/constants/array/max-array-length`][@stdlib/constants/array/max-array-length]: maximum length for a generic array.
124+
119125
</section>
120126

121127
<!-- /.related -->
@@ -124,6 +130,12 @@ try {
124130

125131
<section class="links">
126132

133+
<!-- <related-links> -->
134+
135+
[@stdlib/constants/array/max-array-length]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/array/max-array-length
136+
137+
<!-- </related-links> -->
138+
127139
</section>
128140

129141
<!-- /.links -->

lib/node_modules/@stdlib/constants/complex128/num-bytes/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,13 @@ console.log( COMPLEX128_NUM_BYTES );
6666

6767
<section class="related">
6868

69+
* * *
70+
71+
## See Also
72+
73+
- [`@stdlib/constants/complex64/num-bytes`][@stdlib/constants/complex64/num-bytes]: size (in bytes) of a 64-bit complex number.
74+
- [`@stdlib/constants/float64/num-bytes`][@stdlib/constants/float64/num-bytes]: size (in bytes) of a double-precision floating-point number.
75+
6976
</section>
7077

7178
<!-- /.related -->
@@ -74,6 +81,14 @@ console.log( COMPLEX128_NUM_BYTES );
7481

7582
<section class="links">
7683

84+
<!-- <related-links> -->
85+
86+
[@stdlib/constants/complex64/num-bytes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/complex64/num-bytes
87+
88+
[@stdlib/constants/float64/num-bytes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float64/num-bytes
89+
90+
<!-- </related-links> -->
91+
7792
</section>
7893

7994
<!-- /.links -->

lib/node_modules/@stdlib/constants/complex64/num-bytes/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,13 @@ console.log( COMPLEX64_NUM_BYTES );
6666

6767
<section class="related">
6868

69+
* * *
70+
71+
## See Also
72+
73+
- [`@stdlib/constants/complex128/num-bytes`][@stdlib/constants/complex128/num-bytes]: size (in bytes) of a 128-bit complex number.
74+
- [`@stdlib/constants/float32/num-bytes`][@stdlib/constants/float32/num-bytes]: size (in bytes) of a single-precision floating-point number.
75+
6976
</section>
7077

7178
<!-- /.related -->
@@ -74,6 +81,14 @@ console.log( COMPLEX64_NUM_BYTES );
7481

7582
<section class="links">
7683

84+
<!-- <related-links> -->
85+
86+
[@stdlib/constants/complex128/num-bytes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/complex128/num-bytes
87+
88+
[@stdlib/constants/float32/num-bytes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/num-bytes
89+
90+
<!-- </related-links> -->
91+
7792
</section>
7893

7994
<!-- /.links -->

lib/node_modules/@stdlib/constants/float16/cbrt-eps/README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,15 @@ for ( i = 0; i < 100; i++ ) {
8686

8787
<section class="related">
8888

89+
* * *
90+
91+
## See Also
92+
93+
- [`@stdlib/constants/float16/eps`][@stdlib/constants/float16/eps]: difference between one and the smallest value greater than one that can be represented as a half-precision floating-point number.
94+
- [`@stdlib/constants/float16/sqrt-eps`][@stdlib/constants/float16/sqrt-eps]: square root of half-precision floating-point epsilon.
95+
- [`@stdlib/constants/float32/cbrt-eps`][@stdlib/constants/float32/cbrt-eps]: cube root of single-precision floating-point epsilon.
96+
- [`@stdlib/constants/float64/cbrt-eps`][@stdlib/constants/float64/cbrt-eps]: cube root of double-precision floating-point epsilon.
97+
8998
</section>
9099

91100
<!-- /.related -->
@@ -96,8 +105,18 @@ for ( i = 0; i < 100; i++ ) {
96105

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

108+
<!-- <related-links> -->
109+
99110
[@stdlib/constants/float16/eps]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float16/eps
100111

112+
[@stdlib/constants/float16/sqrt-eps]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float16/sqrt-eps
113+
114+
[@stdlib/constants/float32/cbrt-eps]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/cbrt-eps
115+
116+
[@stdlib/constants/float64/cbrt-eps]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float64/cbrt-eps
117+
118+
<!-- </related-links> -->
119+
101120
</section>
102121

103122
<!-- /.links -->

lib/node_modules/@stdlib/constants/float16/eps/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,13 @@ for ( i = 0; i < 100; i++ ) {
105105

106106
<section class="related">
107107

108+
* * *
109+
110+
## See Also
111+
112+
- [`@stdlib/constants/float32/eps`][@stdlib/constants/float32/eps]: difference between one and the smallest value greater than one that can be represented as a single-precision floating-point number.
113+
- [`@stdlib/constants/float64/eps`][@stdlib/constants/float64/eps]: difference between one and the smallest value greater than one that can be represented as a double-precision floating-point number.
114+
108115
</section>
109116

110117
<!-- /.related -->
@@ -117,6 +124,14 @@ for ( i = 0; i < 100; i++ ) {
117124

118125
[machine-epsilon]: https://en.wikipedia.org/wiki/Machine_epsilon
119126

127+
<!-- <related-links> -->
128+
129+
[@stdlib/constants/float32/eps]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/eps
130+
131+
[@stdlib/constants/float64/eps]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float64/eps
132+
133+
<!-- </related-links> -->
134+
120135
</section>
121136

122137
<!-- /.links -->

lib/node_modules/@stdlib/constants/float16/exponent-bias/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,13 @@ console.log( FLOAT16_EXPONENT_BIAS );
6666

6767
<section class="related">
6868

69+
* * *
70+
71+
## See Also
72+
73+
- [`@stdlib/constants/float32/exponent-bias`][@stdlib/constants/float32/exponent-bias]: the bias of a single-precision floating-point number's exponent.
74+
- [`@stdlib/constants/float64/exponent-bias`][@stdlib/constants/float64/exponent-bias]: the bias of a double-precision floating-point number's exponent.
75+
6976
</section>
7077

7178
<!-- /.related -->
@@ -76,6 +83,14 @@ console.log( FLOAT16_EXPONENT_BIAS );
7683

7784
[half-precision-floating-point-format]: https://en.wikipedia.org/wiki/Half-precision_floating-point_format
7885

86+
<!-- <related-links> -->
87+
88+
[@stdlib/constants/float32/exponent-bias]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/exponent-bias
89+
90+
[@stdlib/constants/float64/exponent-bias]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float64/exponent-bias
91+
92+
<!-- </related-links> -->
93+
7994
</section>
8095

8196
<!-- /.links -->

lib/node_modules/@stdlib/constants/float16/max-safe-integer/README.md

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

7979
<section class="related">
8080

81+
* * *
82+
83+
## See Also
84+
85+
- [`@stdlib/constants/float16/min-safe-integer`][@stdlib/constants/float16/min-safe-integer]: minimum safe half-precision floating-point integer.
86+
- [`@stdlib/constants/float32/max-safe-integer`][@stdlib/constants/float32/max-safe-integer]: maximum safe single-precision floating-point integer.
87+
- [`@stdlib/constants/float64/max-safe-integer`][@stdlib/constants/float64/max-safe-integer]: maximum safe double-precision floating-point integer.
88+
8189
</section>
8290

8391
<!-- /.related -->
@@ -90,6 +98,16 @@ for ( i = 0; i < 100; i++ ) {
9098

9199
[half-precision-floating-point-format]: https://en.wikipedia.org/wiki/Half-precision_floating-point_format
92100

101+
<!-- <related-links> -->
102+
103+
[@stdlib/constants/float16/min-safe-integer]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float16/min-safe-integer
104+
105+
[@stdlib/constants/float32/max-safe-integer]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/max-safe-integer
106+
107+
[@stdlib/constants/float64/max-safe-integer]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float64/max-safe-integer
108+
109+
<!-- </related-links> -->
110+
93111
</section>
94112

95113
<!-- /.links -->

lib/node_modules/@stdlib/constants/float16/max/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,13 @@ console.log( FLOAT16_MAX );
6666

6767
<section class="related">
6868

69+
* * *
70+
71+
## See Also
72+
73+
- [`@stdlib/constants/float32/max`][@stdlib/constants/float32/max]: maximum single-precision floating-point number.
74+
- [`@stdlib/constants/float64/max`][@stdlib/constants/float64/max]: maximum double-precision floating-point number.
75+
6976
</section>
7077

7178
<!-- /.related -->
@@ -76,6 +83,14 @@ console.log( FLOAT16_MAX );
7683

7784
[half-precision-floating-point-format]: https://en.wikipedia.org/wiki/Half-precision_floating-point_format
7885

86+
<!-- <related-links> -->
87+
88+
[@stdlib/constants/float32/max]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/max
89+
90+
[@stdlib/constants/float64/max]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float64/max
91+
92+
<!-- </related-links> -->
93+
7994
</section>
8095

8196
<!-- /.links -->

lib/node_modules/@stdlib/constants/float16/min-safe-integer/README.md

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

7979
<section class="related">
8080

81+
* * *
82+
83+
## See Also
84+
85+
- [`@stdlib/constants/float16/max-safe-integer`][@stdlib/constants/float16/max-safe-integer]: maximum safe half-precision floating-point integer.
86+
- [`@stdlib/constants/float32/min-safe-integer`][@stdlib/constants/float32/min-safe-integer]: minimum safe single-precision floating-point integer.
87+
- [`@stdlib/constants/float64/min-safe-integer`][@stdlib/constants/float64/min-safe-integer]: minimum safe double-precision floating-point integer.
88+
8189
</section>
8290

8391
<!-- /.related -->
@@ -90,6 +98,16 @@ for ( i = 0; i < 100; i++ ) {
9098

9199
[half-precision-floating-point-format]: https://en.wikipedia.org/wiki/Half-precision_floating-point_format
92100

101+
<!-- <related-links> -->
102+
103+
[@stdlib/constants/float16/max-safe-integer]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float16/max-safe-integer
104+
105+
[@stdlib/constants/float32/min-safe-integer]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/min-safe-integer
106+
107+
[@stdlib/constants/float64/min-safe-integer]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float64/min-safe-integer
108+
109+
<!-- </related-links> -->
110+
93111
</section>
94112

95113
<!-- /.links -->

0 commit comments

Comments
 (0)