josdejong/mathjs

Define custom help objects

Aberta

#2.047 aberto em 1 de dez. de 2020

Ver no GitHubGuia do colaborador
 (14 comentários) (1 reação) (0 responsável)JavaScript (1.314 forks)batch import
featurehelp wanted

Métricas do repositório

Stars
 (15.065 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

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?

Guia do colaborador

Direção de pesquisa
Investigue o sistema de ajuda existente no mathjs. Veja como os objetos de ajuda integrados são definidos e registrados. Em seguida, proponha uma maneira de permitir que os usuários definam objetos de ajuda personalizados por meio de um novo método de API (por exemplo, math.defineHelp) ou estendendo o mecanismo de importação para incluir uma propriedade help. Verifique se já existe um registro interno para objetos de ajuda. O objetivo é fazer com que math.help('area') funcione para funções definidas pelo usuário.
Pilha de tecnologia
javascript
Domain
backend
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
JavaScriptmathjs basics
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
65