microsoft / microsoft/azure-devops-python-api
Implement type hints on top of docstring `rtype`
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 684
- Fork
- 218
- Merge medio
- 8g 10h
- PR unite (30g)
- 1
Descrizione
Hi,
The code is quite well documented, and uses docstring heavily. However, the "Python way" is to use type hints which are powerful and enable a good code completion.
For exaample, the client factory (get_git_client, get_build_client, ...) does not have type hints. Due to how it is written, python analyzers can not infer the returned types and this breaks autocompletion.
Could you please generate them them?
For example something like this:
def get_git_client(self) -> GitClient:
"""get_git_client.
Gets the 7.0 version of the GitClient
:rtype: :class:`<GitClient> <azure.devops.v7_0.git.git_client.GitClient>`
"""
return self._connection.get_client('azure.devops.v7_0.git.git_client.GitClient')
Thanks !
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia individuando i metodi factory dei client menzionati nella issue, inclusi get_git_client e get_build_client, e verifica come le loro dichiarazioni rtype nelle docstring corrispondano ai client restituiti. Determina l’ambito delle factory che richiedono annotazioni e verifica che i tipi restituiti risultanti ripristinino il completamento automatico dell’analizzatore; la issue non indica file o test specifici.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- azure, python
- Ambito
- api
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 30/100