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.