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