josdejong/mathjs

Define custom help objects

Aperta

#2047 aperta il 1 dic 2020

Vedi su GitHubGuida contributor
 (14 commenti) (1 reazione) (0 assegnatari)JavaScript (1314 fork)batch import
featurehelp wanted

Metriche repository

Star
 (15.065 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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?

Guida contributor

Direzione di ricerca
Investiga il sistema di aiuto esistente in mathjs. Cerca come vengono definiti e registrati gli oggetti di aiuto integrati. Quindi proponi un modo per consentire agli utenti di definire oggetti di aiuto personalizzati tramite un nuovo metodo API (ad esempio math.defineHelp) o estendendo il meccanismo di importazione per includere una proprietà help. Verifica se esiste già un registro interno per gli oggetti di aiuto. L'obiettivo è far funzionare math.help('area') per funzioni definite dall'utente.
Tech stack
javascript
Dominio
backend
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
JavaScriptmathjs basics
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65