sinonjs/sinon

"API Specification" Style Documentation

Open

#2.003 aberto em 2 de abr. de 2019

Ver no GitHub
 (14 comments) (1 reaction) (0 assignees)JavaScript (9.548 stars) (764 forks)batch import
DocumentationHelp wantedNeeds investigationhacktoberfestpinned

Description

I would love to see API Specification style documentation for Sinon, along the lines of what you see in Java (the gold standard of documentation), or jQuery.

An A-Z alphabetical list of functionality, written in a non-conversational way (which is how the current documentation is currently written) is what this documentation needs.

Guia do colaborador

Pilha de tecnologia
javascript
Domain
documentation
Tipo Issue
documentation
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
4
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
over 1 week
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
stale
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
clear
Prerequisites
JavaScript basicsSinon API knowledge
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
20
Direção de pesquisa
Review existing Sinon documentation structure and consider templates from jQuery API docs. Discuss with maintainers about scope and format. Possibly start with a single function like `sinon.spy` as a prototype.