ynput / ynput/ayon-python-api

`get_project_roots_by_site_id` return value

Abierto
#181 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
Python
Estrellas
16
Forks
15
Merge medio
1 d 9 h
PR fusionados (30 d)
10

Descripción

Is there an existing issue for this?
  • I have searched the existing issues
Current Behavior:

Calling:

ayon_api.get_project_roots_by_site_id(get_current_project_name())

will return just dict[str, str] like:

{'work': 'C:/projects'}

but the docstring states that the return value is dict[str, dict[str ,str]]

Expected Behavior:

Docstring should reflect real state otherwise IDEs will show wrong type hints.

Version

1.0.0

What platform you are running on?

Windows

Steps To Reproduce:

Look at the function docstring

Are there any labels you wish to add?
  • I have added the relevant labels to the bug report.
Relevant log output:

No response

Additional context:

No response

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.

Línea de trabajo

Busca la definición de get_project_roots_by_site_id y lee su implementación junto con el docstring. Alinea el tipo de retorno documentado con el valor observado dict[str, str] y, después, comprueba la documentación de la API circundante o las anotaciones de tipo para verificar su coherencia.

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

Evaluación

Stack tecnológico
python
Área
api
Tipo de issue
Error
Dificultad
1/5
Tiempo estimado
Menos de una hora
Estado de actividad
Estancado
Claridad
Bien especificado
Aptitud para principiantes
55/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.