vmware/pyvmomi

Make vim more explicit in the code

Open

#941 opened on Jan 14, 2021

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (807 forks)batch import
documentationhelp wantedquestion

Repository metrics

Stars
 (2,141 stars)
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

Research direction
Investigate how `vim` is imported and used in pyVmomi. Suggest adding explicit documentation or an alias to clarify its purpose.
Tech stack
python
Domain
apideveloper experience
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90