vmware/pyvmomi

[Documentation] Create a manual page for PerformanceManager

Open

#207 ouverte le 30 janv. 2015

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)Python (807 forks)batch import
documentationhelp wantedsample requestwishlist

Métriques du dépôt

Stars
 (2 141 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

Based on interactions over Issue https://github.com/vmware/pyvmomi/issues/191 we need to create a sample and a manual page featuring PerformanceManager and specifically address that the value -1 in this context is a special data not found value.

This could be some what surprising to some developers as we've observed. So we want to make this something that's easy to google and answer for.

Guide contributeur

Direction de recherche
Examinez l'issue #191 liée dans la description pour comprendre le contexte de la valeur 1 pour PerformanceManager. Ensuite, créez un script d'exemple et une page manuelle dans la documentation de pyvmomi (probablement dans le répertoire 'docs') qui démontre comment utiliser PerformanceManager et explique clairement que 1 indique que les données n'ont pas été trouvées. Assurez vous que la documentation est facile à trouver et inclut des exemples de code.
Stack technique
python
Domaine
documentation
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.
2
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.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Python basicspyvmomi libraryvSphere PerformanceManager concept
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80