josdejong/mathjs

Define custom help objects

Open

#2,047 opened on Dec 1, 2020

View on GitHubContributor guide
 (14 comments) (1 reaction) (0 assignees)JavaScript (1,314 forks)batch import
featurehelp wanted

Repository metrics

Stars
 (15,065 stars)
PR merge metrics
 (PR metrics pending)

Description

For example, if I import a function as follows:

math.import({
  area: function (x, y) {
    return x*y
  }
})

I would like to then define a help object for this new function so I can call math.help("area"). Is this possible?

Contributor guide

Research direction
Investigate the existing help system in mathjs. Look for how built in help objects are defined and registered. Then propose a way to allow users to define custom help objects via a new API method (e.g., math.defineHelp) or by extending the import mechanism to include help property. Check if there is an existing internal registry for help objects. The goal is to make math.help('area') work for user defined functions.
Tech stack
javascript
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
JavaScriptmathjs basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65