vmware/pyvmomi

[Documentation] Create a manual page for PerformanceManager

Open

#207 建立於 2015年1月30日

在 GitHub 查看
 (0 留言) (0 反應) (0 負責人)Python (2,141 star) (807 fork)batch import
documentationhelp wantedsample requestwishlist

描述

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.

貢獻者指南

技術棧
python
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Python basicspyvmomi libraryvSphere PerformanceManager concept
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
80
研究方向
Review the issue #191 linked in the description to understand the context of the 1 value for PerformanceManager. Then, create a sample script and a manual page in the pyvmomi documentation (likely in the 'docs' directory) that demonstrates how to use PerformanceManager and clearly explains that 1 indicates data not found. Ensure the documentation is easy to find and includes code examples.