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.