jwkvam/bowtie

document payloads from plotly events

Open

#196 opened on Feb 4, 2018

View on GitHub
 (0 comments) (0 reactions) (0 assignees)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

Contributor guide

Tech stack
python
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Python programmingPlotly knowledgeDocumentation writing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
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.