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

Repository metrics

Stars
 (319 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Look at existing service methods and add numpy style docstrings following the pattern in the codebase.
Tech stack
python
Domain
documentationbackend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85