miguel-perez/smoothState.js

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

Open

#191 ouverte le 1 juil. 2015

Voir sur GitHub
 (3 commentaires) (0 réactions) (0 assignés)CSS (515 forks)batch import
gh-pages bughelp wanted

Métriques du dépôt

Stars
 (4 433 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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.

Guide contributeur

Direction de recherche
Le problème identifie une incohérence entre les noms de rappels listés sur le site officiel (http://smoothstate.com/advanced implementation.html) et la documentation GitHub. L'auteur soupçonne que la documentation GitHub est correcte. La correction consiste à mettre à jour l'une des sources de documentation pour qu'elle corresponde à l'autre, après avoir vérifié le comportement réel du code. Il s'agit d'une tâche de documentation simple et localisée.
Stack technique
javascript
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Aucun
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90