VorTECHsa / VorTECHsa/python-sdk
"Why doesn’t the example code run"
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 25
- Forks
- 12
- Avg merge
- 20h 47m
- Merged PRs (30d)
- 2
Description
We could think of ways to help users understand why a query is failing (e.g. add a relevant section to the general FAQ section).
For example, when an error of type search() got an unexpected keyword argument occurs, we can point out that new filters and changes are constantly being added to the SDK, so users should ensure they have installed the latest SDK version. This issue ties very well with #126.
Check slack discussion here: https://vortexa.slack.com/archives/CV58WAMRD/p1589376834385900
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the general FAQ section and the context in issue #126, then consult the linked Slack discussion for the proposed guidance. The completed work should explain the search() got an unexpected keyword argument error and direct users to verify that the latest SDK version is installed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100