josdejong/mathjs

Define custom help objects

Open

#2 047 ouverte le 1 déc. 2020

Voir sur GitHub
 (14 commentaires) (1 réaction) (0 assignés)JavaScript (1 298 forks)batch import
featurehelp wanted

Métriques du dépôt

Stars
 (13 832 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

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?

Guide contributeur

Direction de recherche
Examinez le système d'aide existant dans mathjs. Regardez comment les objets d'aide intégrés sont définis et enregistrés. Proposez ensuite un moyen permettant aux utilisateurs de définir des objets d'aide personnalisés via une nouvelle méthode API (par exemple math.defineHelp) ou en étendant le mécanisme d'importation pour inclure une propriété help. Vérifiez s'il existe déjà un registre interne pour les objets d'aide. L'objectif est de faire fonctionner math.help('area') pour les fonctions définies par l'utilisateur.
Stack technique
javascript
Domaine
backend
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
JavaScriptmathjs basics
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
65