miguel-perez/smoothState.js

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

Open

#191 aperta il 1 lug 2015

Vedi su GitHub
 (3 commenti) (0 reazioni) (0 assegnatari)CSS (515 fork)batch import
gh-pages bughelp wanted

Metriche repository

Star
 (4433 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Il problema identifica una discrepanza tra i nomi delle callback elencati sul sito web ufficiale (http://smoothstate.com/advanced implementation.html) e la documentazione su GitHub. L'autore sospetta che la documentazione su GitHub sia corretta. La correzione comporta l'aggiornamento di una delle fonti di documentazione per farla corrispondere all'altra, dopo aver verificato il comportamento effettivo del codice. Si tratta di un'attività di documentazione semplice e localizzata.
Tech stack
javascript
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Nessuno
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90