Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Implement type hints on top of docstring `rtype`

Abierto
#483 1 comentario 1 reacción 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
30/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
azure, python
Área
api

Línea de trabajo

Comience localizando los métodos de factory de clientes mencionados en la issue, incluidos get_git_client y get_build_client, e inspeccione cómo corresponden sus declaraciones rtype de docstring con los clientes devueltos. Determine el alcance de las factories que necesitan anotaciones y verifique que los tipos de retorno resultantes restauren el autocompletado del analizador; la issue no especifica archivos ni pruebas concretos.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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 !

Lenguaje dominante
Python
Estrellas
684
Forks
218
Merge medio
8 d 10 h
PR fusionados (30 d)
1

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de microsoft/azure-devops-python-api

Todos los issues de microsoft/azure-devops-python-api

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.