Define custom help objects · josdejong/mathjs

(14 件のコメント) (1 件のリアクション) (0 人の担当者)JavaScript (1,314 件のフォーク)batch import

featurehelp wanted

Repository metrics

Stars: (15,065 個のスター)
PR merge metrics: (PR metrics pending)

説明

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
Issue 種別: 機能
難度: 3
推定時間: 半日
活動状況: アクティブ
明確さ: おおむね明確
前提条件: JavaScriptmathjs basics
初心者向け度: 65