mapbox/mapbox-sdk-py

Include numpy-style doctrings for all service methods

Open

#195 opened on 2017年6月28日

GitHub で見る
 (0 comments) (0 reactions) (0 assignees)Python (319 stars) (111 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.