NVIDIA / NVIDIA/NeMo-Retriever
[DOC]: Document the client's error codes
Open
Nobody has claimed this yet.
doc
- Dominant language
- Python
- Stars
- 3k
- Forks
- 349
- Avg merge
- 1d 23h
- Merged PRs (30d)
- 116
Description
How would you describe the priority of this documentation request
None
Please provide a link or source to the relevant docs
https://github.com/NVIDIA/nv-ingest/tree/main/client
Describe the problems in the documentation
There is no documentation of the error codes for the client.
(Optional) Propose a correction or improvement
this page is a good example: https://platform.openai.com/docs/guides/error-codes
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 inspecting the client directory linked in the issue and identify the error codes exposed there. Document those codes in the client documentation, using the linked OpenAI error-code page as a format reference, and verify that the documented list covers the client’s errors.
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
- Mostly clear
- Newbie friendliness
- 38/100