fix: #3472 rename physical constant coulomb to coulombConstant

Author: josdejong

HISTORY.md

@@ -5,6 +5,8 @@
 - Fix: #3482 mathjs throwing an error related to `BigInt`  when loading in
   specific environments.
 - Fix: syntax section of function `numeric` (see #3448).
+- Fix: #3472 rename physical constant `coulomb` to `coulombConstant`. The old
+  name is still available for backward compatibility.
 
 # 2025-05-21, 14.5.0
 

src/expression/embeddedDocs/embeddedDocs.js

@@ -295,7 +295,7 @@ export const embeddedDocs = {
   magneticConstant: { description: 'Magnetic constant (vacuum permeability)', examples: ['magneticConstant'] },
   electricConstant: { description: 'Electric constant (vacuum permeability)', examples: ['electricConstant'] },
   vacuumImpedance: { description: 'Characteristic impedance of vacuum', examples: ['vacuumImpedance'] },
-  coulomb: { description: 'Coulomb\'s constant', examples: ['coulomb'] },
+  coulombConstant: { description: 'Coulomb\'s constant', examples: ['coulombConstant'] },
   elementaryCharge: { description: 'Elementary charge', examples: ['elementaryCharge'] },
   bohrMagneton: { description: 'Bohr magneton', examples: ['bohrMagneton'] },
   conductanceQuantum: { description: 'Conductance quantum', examples: ['conductanceQuantum'] },

src/factoriesAny.js

@@ -297,6 +297,7 @@ export {
   createClassicalElectronRadius,
   createConductanceQuantum,
   createCoulomb,
+  createCoulombConstant,
   createDeuteronMass,
   createEfimovFactor,
   createElectricConstant,

src/type/unit/physicalConstants.js

@@ -12,7 +12,8 @@ export const createReducedPlanckConstant = /* #__PURE__ */ unitFactory('reducedP
 export const createMagneticConstant = /* #__PURE__ */ unitFactory('magneticConstant', '1.25663706212e-6', 'N A^-2')
 export const createElectricConstant = /* #__PURE__ */ unitFactory('electricConstant', '8.8541878128e-12', 'F m^-1')
 export const createVacuumImpedance = /* #__PURE__ */ unitFactory('vacuumImpedance', '376.730313667', 'ohm')
-export const createCoulomb = /* #__PURE__ */ unitFactory('coulomb', '8.987551792261171e9', 'N m^2 C^-2')
+export const createCoulomb = /* #__PURE__ */ unitFactory('coulomb', '8.987551792261171e9', 'N m^2 C^-2') // Deprecated in favor of coulombConstant
+export const createCoulombConstant = /* #__PURE__ */ unitFactory('coulombConstant', '8.987551792261171e9', 'N m^2 C^-2')
 export const createElementaryCharge = /* #__PURE__ */ unitFactory('elementaryCharge', '1.602176634e-19', 'C')
 export const createBohrMagneton = /* #__PURE__ */ unitFactory('bohrMagneton', '9.2740100783e-24', 'J T^-1')
 export const createConductanceQuantum = /* #__PURE__ */ unitFactory('conductanceQuantum', '7.748091729863649e-5', 'S')

src/utils/snapshot.js

@@ -159,6 +159,7 @@ export function createSnapshotFromFactories (factories) {
     'compile',
     'parser',
     'chain',
+    'coulomb',
     'reviver',
     'replacer'
   ])

test/node-tests/doc.test.js

@@ -243,6 +243,7 @@ const knownUndocumented = new Set([
   'conductanceQuantum',
   'ConstantNode',
   'coulomb',
+  'coulombConstant',
   'createUnit',
   'DenseMatrix',
   'deuteronMass',

test/unit-tests/expression/function/help.test.js

@@ -6,7 +6,7 @@ let mathDocs = math.create(math.all)
 const originalConfig = mathDocs.config()
 // Add names to the skipDocs array if they are not meant to have embedded docs
 const skipDocs = new Set(['import', 'addScalar', 'divideScalar', 'equalScalar', 'multiplyScalar',
-  'subtractScalar', 'apply', 'replacer', 'reviver'])
+  'subtractScalar', 'apply', 'replacer', 'reviver', 'coulomb'])
 
 // Add names to skipExamples if their examples in the embedded docs contain acceptable errors
 const skipExamples = new Set([])
@@ -22,7 +22,7 @@ const testExamples = new Set([...testDocs].filter(name => {
 
 function runExamplesInDocs (name) {
   mathDocs.config(originalConfig)
-  // every funciton should have doc.examples
+  // every function should have doc.examples
   const examples = mathDocs.evaluate(`help("${name}")`).doc.examples
   try {
     // validate if the examples run without errors

test/unit-tests/type/unit/physicalConstants.test.js

@@ -9,6 +9,7 @@ import {
   createClassicalElectronRadius,
   createConductanceQuantum,
   createCoulomb,
+  createCoulombConstant,
   createDeuteronMass,
   createEfimovFactor,
   createElectricConstant,
@@ -78,6 +79,8 @@ describe('physical constants', function () {
     assert.strictEqual(createElectricConstant(dependencies).toString(), '8.8541878128e-12 F / m')
     assert.strictEqual(createVacuumImpedance(dependencies).toString(), '376.730313667 ohm')
     assert.strictEqual(createCoulomb(dependencies).toString(), '8.987551792261171e+9 (N m^2) / C^2')
+    assert.strictEqual(createCoulombConstant(dependencies).toString(), '8.987551792261171e+9 (N m^2) / C^2')
+    assert.strictEqual(math.coulombConstant.toString(), '8.987551792261171e+9 (N m^2) / C^2')
     assert.strictEqual(createElementaryCharge(dependencies).toString(), '1.602176634e-19 C')
     assert.strictEqual(createBohrMagneton(dependencies).toString(), '9.2740100783e-24 J / T')
     assert.strictEqual(createConductanceQuantum(dependencies).toString(), '7.748091729863649e-5 S')