Docs | Docs Section

[ethanillingsworth]

Summary

See this page for more details. Details section pulled from the page above.

Details

Docs Contribution Section

• Docs are generated using JSDoc
• Edit, add, or remove JSDoc comments in src/ (main source files)
• Run npm run docs (installs dependencies automatically)
• Output is written to /docs
• JSDoc config is defined in jsdoc.json
• Use valid JSDoc comment blocks (see example below)

Example

/**
* Calculates the area of a rectangle.
*
* @function calculateRectangleArea
* @param {number} width - The width of the rectangle in units.
* @param {number} height - The height of the rectangle in units.
* @returns {number} The calculated area (width × height).
* @throws {TypeError} If either `width` or `height` is not a number.
* @example
* // Basic usage
* const area = calculateRectangleArea(5, 10);
* console.log(area); // 50
*
* @see {@link https://en.wikipedia.org/wiki/Rectangle|Rectangle on Wikipedia}
*/
function calculateRectangleArea(width, height) {
  if (typeof width !== 'number' || typeof height !== 'number') {
    throw new TypeError('Width and height must be numbers.');
  }
  return width * height;
}

[calebjubal]

Hey @ethanillingsworth, please assign this issue to me, I'll work on it!

[ethanillingsworth]

@calebjubal assigning you now! Best of luck!

[ethanillingsworth]

Assignee removed for inactivity (see Inactivity Clause)