ynput / ynput/ayon-python-api

`get_project_roots_by_site_id` return value

Aperta
#181 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
Python
Stelle
16
Fork
15
Merge medio
1g 9h
PR unite (30g)
10

Descrizione

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

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Cerca la definizione di get_project_roots_by_site_id e leggi la sua implementazione insieme al docstring. Allinea il tipo restituito documentato al valore osservato dict[str, str], quindi verifica la coerenza della documentazione dell’API circostante o delle annotazioni di tipo.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
api
Tipo di issue
Bug
Difficoltà
1/5
Tempo stimato
Meno di un'ora
Stato di attività
Ferma
Chiarezza
Specificata chiaramente
Idoneità per principianti
55/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.