mapbox/mapbox-sdk-py

Include numpy-style doctrings for all service methods

Ouverte

#195 ouverte le 28 juin 2017

Voir sur GitHubGuide contributeur
 (0 commentaire) (0 réaction) (0 personne assignée)Python (111 forks)batch import
documentationgood first issue

Métriques du dépôt

Stars
 (319 étoiles)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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

Guide contributeur

Direction de recherche
Regardez les methodes de service existantes et ajoutez des docstrings de style numpy en suivant le modele dans le codebase.
Stack technique
python
Domaine
documentationbackend
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Python
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85