josdejong/mathjs

Define custom help objects

Open

#2,047 创建于 2020年12月1日

在 GitHub 查看
 (14 评论) (1 反应) (0 负责人)JavaScript (1,298 fork)batch import
featurehelp wanted

仓库指标

Star
 (13,832 star)
PR 合并指标
 (30 天内没有已合并 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
议题类型
功能
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
半天
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
基本清晰
前置要求
JavaScriptmathjs basics
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
65