vmware/pyvmomi

Make vim more explicit in the code

Aperta

#941 aperta il 14 gen 2021

Vedi su GitHubGuida contributor
 (0 commenti) (0 reazioni) (0 assegnatari)Python (807 fork)batch import
documentationhelp wantedquestion

Metriche repository

Star
 (2141 stelle)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Esamina il meccanismo di lazy loading alla riga 219 del file init .py. Proponi di rinominare l'import 'vim' con un nome più descrittivo o di aggiungere commenti in linea per chiarire che 'vim' è un namespace per le classi VMware Infrastructure Model. Se si rinomina, assicurarsi la compatibilità con le versioni precedenti.
Tech stack
python
Dominio
apideveloper experience
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Python
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90