equinor / equinor/dsis-python-client

Fix docs/examples with cast_results() method on DSISClient

Aperta
#76 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
Python
Stelle
2
Fork
0
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

1. [example ](https://github.com/equinor/dsis-python-client/blob/85a7f70ac99d0da34849246c41fad2724d38cf40/src/dsis_client/api/query/builder.py#L32)suggesting it is a `query `method, while it is on `client`.
2. [this example](https://github.com/equinor/dsis-python-client/blob/85a7f70ac99d0da34849246c41fad2724d38cf40/src/dsis_client/api/client/_query.py#L187) suggests twice that the `response` has a `value` key, but I am getting a generator object from `client.executeQuery(query)`, so it is a bit misleading. Unless there can be different response types here?

Didn't check for more examples, but might be worth checking.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia dagli esempi referenziati in src/dsis_client/api/query/builder.py intorno alla riga 32 e in src/dsis_client/api/client/_query.py intorno alla riga 187; esamina cast_results() e il comportamento del valore restituito da executeQuery(query) prima di cercare esempi simili. Il lavoro è completato quando gli esempi identificano correttamente l'oggetto proprietario e la forma della risposta, e viene corretta la formulazione fuorviante relativa a valore e chiave.

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

Valutazione

Stack tecnologico
python
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
48/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.