jwkvam/bowtie

document payloads from plotly events

Open

#196 ouverte le 4 févr. 2018

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)Python (760 stars) (70 forks)batch import
documentationeasygood first issue

Description

These have been TODOs for quite some time :(

For example: https://github.com/jwkvam/bowtie/blob/master/bowtie/visual.py#L318

Guide contributeur

Stack technique
python
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.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 hours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
mostly clear
Prérequis
Python programmingPlotly knowledgeDocumentation writing
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70
Direction de recherche
Start by examining the file bowtie/visual.py around line 318, which contains TODO comments for documenting payloads from plotly events. Understand the payload structures emitted by plotly events in the context of the bowtie library. Look for similar TODOs in other files. Create documentation describing the payload format, fields, and usage. No linked PRs or comments exist, so focus on code analysis.