jwkvam/bowtie

document payloads from plotly events

Open

#196 创建于 2018年2月4日

在 GitHub 查看
 (0 评论) (0 反应) (0 负责人)Python (760 star) (70 fork)batch import
documentationeasygood first issue

描述

These have been TODOs for quite some time :(

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

贡献者指南

技术栈
python
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
Python programmingPlotly knowledgeDocumentation writing
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70
研究方向
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.