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 (111 forks)batch import
documentationgood first issue

Repository metrics

Stars
 (319 stars)
PR merge metrics
 (30d に merged 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
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
1
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Python
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
85