Define custom help objects · josdejong/mathjs

(14 条评论) (1 个反应) (0 位负责人)JavaScript (1,314 个派生)batch import

featurehelp wanted

仓库指标

星标: (15,065 个星标)
PR 合并指标: (PR 指标待抓取)

描述

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?

贡献者指南

研究方向: 研究 mathjs 中现有的帮助系统。查看内置帮助对象是如何定义和注册的。然后提出一种方法，允许用户通过新的 API 方法（例如 math.defineHelp）或通过扩展导入机制来包含帮助属性来自定义帮助对象。检查是否已存在帮助对象的内部注册表。目标是让 math.help('area') 对用户定义的函数生效。
技术栈: javascript
领域: backend
议题类型: 功能
难度: 3
预计时间: 半天
活动状态: 活跃
清晰度: 基本清晰
前置要求: JavaScriptmathjs basics
新手友好度: 65