equinor / equinor/dsis-python-client

Fix docs/examples with cast_results() method on DSISClient

Offen
#76 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
Python
Sterne
2
Forks
0
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne mit den referenzierten Beispielen in src/dsis_client/api/query/builder.py etwa bei Zeile 32 und in src/dsis_client/api/client/_query.py etwa bei Zeile 187; sieh dir cast_results() und das Rückgabeverhalten von executeQuery(query) an, bevor du nach ähnlichen Beispielen suchst. Als erledigt gilt die Aufgabe, wenn die Beispiele das zuständige Objekt und die Form der Antwort korrekt identifizieren und die irreführende Formulierung zu Wert und Schlüssel korrigiert ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
48/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.