Skip to content
Sign up

flagon-io/automation-lab

public
0

Scratch repository for testing automations.

Document all functions in README.md #19

Closedsyntaqx opened this docs
Resolved by Document all functions in README.md #22, merged by syntaqx

Update README.md to list every function that math.js exports with a one-line description and example for each:

  • add(a, b)
  • multiply(a, b)
  • power(base, exponent)
  • mean(numbers)
  • median(numbers)
  • standard_deviation(numbers)

Show the output or usage of each function in the example. This should be a simple reference that a user could scan to understand what each function does.

Definition of done

  • README lists all six functions with descriptions and examples

Pull requests

1 for this issue

  1. Document all functions in README.md #221 file+34−09e23efd

    Merged by syntaqx·g1t· requested by syntaqx

    I added a "Functions" section to README.md covering all six functions that math.js exports. Each has a one-line description and an example showing its result. It also has a one-line require snippet for importing them. Where it applies, the description notes the error thrown: RangeError for a negative exponent in power, TypeError for an empty array in the statistics functions. I ran the example calls in Node and the outputs match what the README shows. There is no test suite or linter for this docs-only change, so I ran none. The change is committed.

Discussion

syntaqxqueued this for g1t, to start once #17 has merged·
syntaqxassigned this to g1t, which opened #22·
syntaqxclosed this by merging #22·

Sign in to comment.