fix: add embedded docs for the deprecated physical constant coulomb, see #3472

Author: josdejong

HISTORY.md

@@ -1,5 +1,11 @@
 # History
 
+# unpublished changes since 14.5.1
+
+- Fix: add embedded docs for the deprecated physical constant `coulomb`, 
+  see #3472.
+
+
 # 2025-05-28, 14.5.1
 
 - Fix: #3482 mathjs throwing an error related to `BigInt`  when loading in

src/expression/embeddedDocs/embeddedDocs.js

@@ -295,6 +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. Deprecated in favor of coulombConstant', examples: ['coulombConstant'] },
   coulombConstant: { description: 'Coulomb\'s constant', examples: ['coulombConstant'] },
   elementaryCharge: { description: 'Elementary charge', examples: ['elementaryCharge'] },
   bohrMagneton: { description: 'Bohr magneton', examples: ['bohrMagneton'] },

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', 'coulomb'])
+  'subtractScalar', 'apply', 'replacer', 'reviver'])
 
 // Add names to skipExamples if their examples in the embedded docs contain acceptable errors
 const skipExamples = new Set([])