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