vmware/pyvmomi

Make vim more explicit in the code

Open

#941 ouverte le 14 janv. 2021

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)Python (807 forks)batch import
documentationhelp wantedquestion

Métriques du dépôt

Stars
 (2 141 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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.

Guide contributeur

Direction de recherche
Examinez le mécanisme de chargement différé à la ligne 219 du fichier init .py. Proposez soit de renommer l'importation 'vim' en quelque chose de plus descriptif, soit d'ajouter des commentaires en ligne pour clarifier que 'vim' est un espace de noms pour les classes VMware Infrastructure Model. Assurez la rétrocompatibilité en cas de renommage.
Stack technique
python
Domaine
apideveloper experience
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Python
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90