miguel-perez/smoothState.js

Callsbacks (or hooks) on the website and github documentation do not correspond with each other

Open

#191 aberto em 1 de jul. de 2015

Ver no GitHub
 (3 comments) (0 reactions) (0 assignees)CSS (515 forks)batch import
gh-pages bughelp wanted

Métricas do repositório

Stars
 (4.433 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

On the website, these callbacks are listed in the documentation:

  • onStart
  • onProgress
  • onEnd

But on the GitHub documentation, these hooks are listed:

  • onBefore
  • onStart
  • onProgress
  • onReady
  • onAfter

I'm going to assume the ones on github are the right ones, but now many people is using onEnd because that's what is in all the online examples, while onEnd is nowhere to be found on the GitHub documentation.

Guia do colaborador

Direção de pesquisa
O problema identifica uma incompatibilidade entre os nomes de callback listados no site oficial (http://smoothstate.com/advanced implementation.html) e a documentação do GitHub. O autor suspeita que a documentação do GitHub está correta. A correção envolve atualizar uma das fontes de documentação para corresponder à outra, após verificar o comportamento real do código. Esta é uma tarefa de documentação simples e localizada.
Pilha de tecnologia
javascript
Domain
documentation
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.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
None
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90