jwkvam/bowtie

document payloads from plotly events

Open

#196 geöffnet am 4. Feb. 2018

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (760 Stars) (70 Forks)batch import
documentationeasygood first issue

Beschreibung

These have been TODOs for quite some time :(

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

Contributor Guide

Tech Stack
python
Domain
documentation
Issue Type
documentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
mostly clear
Voraussetzungen
Python programmingPlotly knowledgeDocumentation writing
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70
Research-Richtung
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.