mapbox/mapbox-sdk-py

Include numpy-style doctrings for all service methods

Open

#195 建立於 2017年6月28日

在 GitHub 查看
 (0 留言) (0 反應) (0 負責人)Python (111 fork)batch import
documentationgood first issue

倉庫指標

Star
 (319 star)
PR 合併指標
 (30 天內沒有已合併 PR)

描述

Some of our service methods are missing docstrings altogether, others have narrative comments only. We should use numpy-style docstrings throughout to

  • specify Parameters, Return values
  • facilitate API doc generation

貢獻者指南

研究方向
查看現有的服務方法，並按照程式碼庫中的模式添加numpy風格的文檔字串。
技術棧
python
領域
documentationbackend
議題類型
文件
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
1
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 小時
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
Python
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
85