From ba7421eef08de8ed8515c24727fa3d0b5a6b68e9 Mon Sep 17 00:00:00 2001 From: Claude Date: Sat, 30 May 2026 13:19:40 +0000 Subject: [PATCH] docs: document exported constants in `assert/is-{big,little}-endian` Propagates fix from 5e64030 ("docs: document exported constant in `os/num-cpus`") to sibling packages whose exported singleton constant was declared as an empty `var bool;` in `// VARIABLES //` and assigned later in `// MAIN //` without a JSDoc constant block. --- .../@stdlib/assert/is-big-endian/lib/main.js | 13 +++++++------ .../@stdlib/assert/is-little-endian/lib/main.js | 13 +++++++------ 2 files changed, 14 insertions(+), 12 deletions(-) diff --git a/lib/node_modules/@stdlib/assert/is-big-endian/lib/main.js b/lib/node_modules/@stdlib/assert/is-big-endian/lib/main.js index 060ed95e9a29..37400ed835e5 100644 --- a/lib/node_modules/@stdlib/assert/is-big-endian/lib/main.js +++ b/lib/node_modules/@stdlib/assert/is-big-endian/lib/main.js @@ -23,11 +23,6 @@ var ctors = require( './ctors.js' ); -// VARIABLES // - -var bool; - - // FUNCTIONS // /** @@ -63,7 +58,13 @@ function isBigEndian() { // MAIN // -bool = isBigEndian(); +/** +* Boolean indicating if an environment is big endian. +* +* @constant +* @type {boolean} +*/ +var bool = isBigEndian(); // eslint-disable-line vars-on-top // EXPORTS // diff --git a/lib/node_modules/@stdlib/assert/is-little-endian/lib/main.js b/lib/node_modules/@stdlib/assert/is-little-endian/lib/main.js index 190df3de2b3a..688ffb043b26 100644 --- a/lib/node_modules/@stdlib/assert/is-little-endian/lib/main.js +++ b/lib/node_modules/@stdlib/assert/is-little-endian/lib/main.js @@ -23,11 +23,6 @@ var ctors = require( './ctors.js' ); -// VARIABLES // - -var bool; - - // FUNCTIONS // /** @@ -63,7 +58,13 @@ function isLittleEndian() { // MAIN // -bool = isLittleEndian(); +/** +* Boolean indicating if an environment is little endian. +* +* @constant +* @type {boolean} +*/ +var bool = isLittleEndian(); // eslint-disable-line vars-on-top // EXPORTS //