josdejong/mathjs

No embedded docs for (some?) units

Aberta

#2.449 aberto em 26 de fev. de 2022

Ver no GitHubGuia do colaborador
 (3 comentários) (0 reação) (0 responsável)JavaScript (1.314 forks)batch import
bugcategory:unitsdocumentationhelp wanted

Métricas do repositório

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

Description

With the restored autocomplete facility in the demo, I discovered that mathjs knows about the units 'candela' and 'angstrom'. As these seem somewhat esoteric, I tried help(candela) and help('candela') (and similarly for angstrom) in the homepage demo, and all of these calls returned Error: No documentation found on "candela".

There should be (1) a test that all appropriate symbols have embedded docs, and (2) all units should have embedded docs.

Guia do colaborador

Direção de pesquisa
Examine as definições de unidade no diretório 'src/unit' para encontrar todas as unidades definidas. Verifique cada unidade em busca de strings de documentação incorporadas. Adicione a documentação ausente para unidades como 'candela' e 'angstrom'. Em seguida, crie um teste (provavelmente em 'test/unit') que itera sobre todas as unidades e afirma que cada uma possui uma string de documentação. Consulte os padrões de documentação existentes na base de código.
Pilha de tecnologia
javascripttypescript
Domain
backend
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
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.
Claro
Prerequisites
GitNode.js
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85