mapbox/mapbox-sdk-py

Include numpy-style doctrings for all service methods

Open

#195 建立於 2017年6月28日

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

描述

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

貢獻者指南

技術棧
python
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Pythonnumpy docstring style
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
70
研究方向
Review the existing codebase, especially the service methods in the services/ directory, to identify methods lacking docstrings. Look at CONTRIBUTING.md for any documentation guidelines. Check if there are any existing numpy style docstrings in the repository to follow as a template.