Make vim more explicit in the code
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.3k
- Forks
- 763
- PR merge metrics
- No merged PRs in 30d
Description
If I want to view someone else's code and I see a line like:
from pyVmomi import vim
I immediately want to check out what is vim. But this in turn, takes me to the section of https://github.com/vmware/pyvmomi/blob/a2d5df0b57d7e359b220493c9c77d1635705ef12/pyVmomi/__init__.py#L219
where I read lines like "Files can just import the top level namespace and we will figure out what to load and when".
That's great, but I don't have the tools to figure this out, so I need to know what this vim exactly is.
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 reading pyVmomi/init.py around line 219 and follow how the top-level namespace exposes vim. Clarify what vim refers to for readers encountering from pyVmomi import vim, with completion marked by documentation or code that makes its identity understandable without requiring the namespace-loading mechanism.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100