vmware/pyvmomi

[Documentation] Create a manual page for PerformanceManager

Open

#207 aberto em 30 de jan. de 2015

Ver no GitHub
 (0 comments) (0 reactions) (0 assignees)Python (807 forks)batch import
documentationhelp wantedsample requestwishlist

Métricas do repositório

Stars
 (2.141 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

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.

Guia do colaborador

Direção de pesquisa
Revise a issue #191 vinculada na descrição para entender o contexto do valor 1 para o PerformanceManager. Em seguida, crie um script de exemplo e uma página manual na documentação do pyvmomi (provavelmente no diretório 'docs') que demonstre como usar o PerformanceManager e explique claramente que 1 indica dados não encontrados. Certifique se de que a documentação seja fácil de encontrar e inclua exemplos de código.
Pilha de tecnologia
python
Domain
documentation
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.
2
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.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Python basicspyvmomi libraryvSphere PerformanceManager concept
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80