josdejong/mathjs

Define custom help objects

Offen

#2.047 geöffnet am 01.12.2020

Auf GitHub ansehenContributor Guide
 (14 Kommentare) (1 Reaktion) (0 zugewiesene Personen)JavaScript (1.314 Forks)batch import
featurehelp wanted

Repository-Metriken

Stars
 (15.065 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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-Richtung
Untersuche das vorhandene Hilfesystem in mathjs. Sieh dir an, wie integrierte Hilfeobjekte definiert und registriert werden. Schlagen Sie dann eine Möglichkeit vor, wie Benutzer benutzerdefinierte Hilfeobjekte über eine neue API Methode (z.B. math.defineHelp) oder durch Erweiterung des Importmechanismus um eine help Eigenschaft definieren können. Überprüfen Sie, ob es bereits ein internes Register für Hilfeobjekte gibt. Ziel ist es, dass math.help('area') für benutzerdefinierte Funktionen funktioniert.
Tech Stack
javascript
Domain
backend
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
JavaScriptmathjs basics
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
65