Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Fix docs/examples with cast_results() method on DSISClient

Open
#76 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
48/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Start with the referenced examples in src/dsis_client/api/query/builder.py around line 32 and src/dsis_client/api/client/_query.py around line 187; inspect cast_results() and the executeQuery(query) return behavior before checking for similar examples. Done means the examples accurately identify the owning object and response shape, with the misleading value-key wording corrected.

Written by the indexing model from the issue text.

Description

  1. example suggesting it is a query method, while it is on client.
  2. this example 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.

Dominant language
Python
Stars
2
Forks
0
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from equinor/dsis-python-client

All issues in equinor/dsis-python-client

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.