vmware/pyvmomi

[Documentation] Create a manual page for PerformanceManager

Open

#207 aperta il 30 gen 2015

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Python (807 fork)batch import
documentationhelp wantedsample requestwishlist

Metriche repository

Star
 (2141 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Rivedi l'issue #191 collegata nella descrizione per comprendere il contesto del valore 1 per PerformanceManager. Quindi, crea uno script di esempio e una pagina manuale nella documentazione di pyvmomi (probabilmente nella directory 'docs') che dimostri come utilizzare PerformanceManager e spieghi chiaramente che 1 indica dati non trovati. Assicurati che la documentazione sia facile da trovare e includa esempi di codice.
Tech stack
python
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Python basicspyvmomi libraryvSphere PerformanceManager concept
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80