From 80967b471e02f25753820f424555f795b02ef7e4 Mon Sep 17 00:00:00 2001 From: Claude Date: Tue, 14 Jul 2026 12:23:06 +0000 Subject: [PATCH] docs: rename `E` -> `FLOAT32_E` in `@stdlib/constants/float32/e` The `@stdlib/constants/float32/*` namespace uses a `FLOAT32_` identifier convention consistently across README headings, `lib/index.js` variable declarations, TypeScript declarations, example scripts, and tests: 65 of 68 sibling packages (95.6%) conform. The `e` package was the sole outlier, using bare `E` throughout, having been ported from `constants/float64/e` where the namespace convention is unprefixed and never re-aligned. This mirrors the drift PR #12432 corrected in the sibling `nan` package (README heading `# NAN` -> `# FLOAT32_NAN`). Renames the internal identifier in `README.md`, `lib/index.js`, `docs/types/index.d.ts`, `docs/types/test.ts`, `examples/index.js`, and `test/test.js`. The exported numeric value is unchanged; `require(...)` consumers observe no difference (the exported binding was already publicly documented as `FLOAT32_E` via the `lib/index.js` `@example` line and via `namespace/pkg2alias/data.csv`). --- .../@stdlib/constants/float32/e/README.md | 12 ++++++------ .../constants/float32/e/docs/types/index.d.ts | 6 +++--- .../@stdlib/constants/float32/e/docs/types/test.ts | 4 ++-- .../@stdlib/constants/float32/e/examples/index.js | 4 ++-- .../@stdlib/constants/float32/e/lib/index.js | 4 ++-- .../@stdlib/constants/float32/e/test/test.js | 6 +++--- 6 files changed, 18 insertions(+), 18 deletions(-) diff --git a/lib/node_modules/@stdlib/constants/float32/e/README.md b/lib/node_modules/@stdlib/constants/float32/e/README.md index 30c74a9f504e..08ce1d6826b7 100644 --- a/lib/node_modules/@stdlib/constants/float32/e/README.md +++ b/lib/node_modules/@stdlib/constants/float32/e/README.md @@ -18,7 +18,7 @@ limitations under the License. --> -# E +# FLOAT32_E > The mathematical constant [_e_][e]. @@ -27,15 +27,15 @@ limitations under the License. ## Usage ```javascript -var E = require( '@stdlib/constants/float32/e' ); +var FLOAT32_E = require( '@stdlib/constants/float32/e' ); ``` -#### E +#### FLOAT32_E The mathematical constant [_e_][e], also known as Euler's number or Napier's constant. [_e_][e] is the base of the natural logarithm. ```javascript -var bool = ( E === 2.7182817459106445 ); +var bool = ( FLOAT32_E === 2.7182817459106445 ); // returns true ``` @@ -52,9 +52,9 @@ var bool = ( E === 2.7182817459106445 ); ```javascript -var E = require( '@stdlib/constants/float32/e' ); +var FLOAT32_E = require( '@stdlib/constants/float32/e' ); -console.log( E ); +console.log( FLOAT32_E ); // => 2.7182817459106445 ``` diff --git a/lib/node_modules/@stdlib/constants/float32/e/docs/types/index.d.ts b/lib/node_modules/@stdlib/constants/float32/e/docs/types/index.d.ts index a4af37e9df15..248a15a2a3fd 100644 --- a/lib/node_modules/@stdlib/constants/float32/e/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/constants/float32/e/docs/types/index.d.ts @@ -22,12 +22,12 @@ * Euler's number. * * @example -* var e = E; +* var e = FLOAT32_E; * // returns 2.7182817459106445 */ -declare const E: number; +declare const FLOAT32_E: number; // EXPORTS // -export = E; +export = FLOAT32_E; diff --git a/lib/node_modules/@stdlib/constants/float32/e/docs/types/test.ts b/lib/node_modules/@stdlib/constants/float32/e/docs/types/test.ts index 763c1963b354..16d394f58c95 100644 --- a/lib/node_modules/@stdlib/constants/float32/e/docs/types/test.ts +++ b/lib/node_modules/@stdlib/constants/float32/e/docs/types/test.ts @@ -16,7 +16,7 @@ * limitations under the License. */ -import E = require( './index' ); +import FLOAT32_E = require( './index' ); // TESTS // @@ -24,5 +24,5 @@ import E = require( './index' ); // The export is a number... { // eslint-disable-next-line @typescript-eslint/no-unused-expressions - E; // $ExpectType number + FLOAT32_E; // $ExpectType number } diff --git a/lib/node_modules/@stdlib/constants/float32/e/examples/index.js b/lib/node_modules/@stdlib/constants/float32/e/examples/index.js index 3ac8e579c54e..797348125c01 100644 --- a/lib/node_modules/@stdlib/constants/float32/e/examples/index.js +++ b/lib/node_modules/@stdlib/constants/float32/e/examples/index.js @@ -18,7 +18,7 @@ 'use strict'; -var E = require( './../lib' ); +var FLOAT32_E = require( './../lib' ); -console.log( E ); +console.log( FLOAT32_E ); // => 2.7182817459106445 diff --git a/lib/node_modules/@stdlib/constants/float32/e/lib/index.js b/lib/node_modules/@stdlib/constants/float32/e/lib/index.js index 6e01b0e44dc5..ce9f8e588b85 100644 --- a/lib/node_modules/@stdlib/constants/float32/e/lib/index.js +++ b/lib/node_modules/@stdlib/constants/float32/e/lib/index.js @@ -45,9 +45,9 @@ var float64ToFloat32 = require( '@stdlib/number/float64/base/to-float32' ); * @see [OEIS]{@link https://oeis.org/A001113} * @see [Wikipedia]{@link https://en.wikipedia.org/wiki/E_(mathematical_constant)} */ -var E = float64ToFloat32( 2.718281828459045 ); +var FLOAT32_E = float64ToFloat32( 2.718281828459045 ); // EXPORTS // -module.exports = E; +module.exports = FLOAT32_E; diff --git a/lib/node_modules/@stdlib/constants/float32/e/test/test.js b/lib/node_modules/@stdlib/constants/float32/e/test/test.js index f34ecc589d50..2bb92564541b 100644 --- a/lib/node_modules/@stdlib/constants/float32/e/test/test.js +++ b/lib/node_modules/@stdlib/constants/float32/e/test/test.js @@ -21,18 +21,18 @@ // MODULES // var tape = require( 'tape' ); -var E = require( './../lib' ); +var FLOAT32_E = require( './../lib' ); // TESTS // tape( 'main export is a number', function test( t ) { t.ok( true, __filename ); - t.strictEqual( typeof E, 'number', 'main export is a number' ); + t.strictEqual( typeof FLOAT32_E, 'number', 'main export is a number' ); t.end(); }); tape( 'export is a single-precision floating-point number equal to 2.7182817459106445', function test( t ) { - t.strictEqual( E, 2.7182817459106445, 'returns expected value' ); + t.strictEqual( FLOAT32_E, 2.7182817459106445, 'returns expected value' ); t.end(); });