[Documentation] Create a manual page for PerformanceManager
Open
Nobody has claimed this yet.
documentation
help wanted
sample request
wishlist
- Dominant language
- Python
- Stars
- 2.3k
- Forks
- 763
- PR merge metrics
- No merged PRs in 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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing Issue 191 and the repository’s existing sample and manual documentation conventions for PerformanceManager. Done means a sample and manual page clearly explain PerformanceManager and explicitly identify -1 as the special data-not-found value.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100