mapbox/mapbox-sdk-py

Include numpy-style doctrings for all service methods

Open

#195 opened on Jun 28, 2017

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (319 stars) (111 forks)batch import
documentationgood first issue

Description

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

Contributor guide

Tech stack
python
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Pythonnumpy docstring style
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
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.