mapbox/mapbox-sdk-py

Include numpy-style doctrings for all service methods

Open

#195 aberto em 28 de jun. de 2017

Ver no GitHub
 (0 comments) (0 reactions) (0 assignees)Python (111 forks)batch import
documentationgood first issue

Métricas do repositório

Stars
 (319 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 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

Guia do colaborador

Direção de pesquisa
Observe os métodos de serviço existentes e adicione docstrings no estilo numpy seguindo o padrão no código.
Pilha de tecnologia
python
Domain
documentationbackend
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Python
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85