oracle / oracle/oci-python-sdk
Provide proper SDK Documentation
Open
Nobody has claimed this yet.
SDK
- Dominant language
- Python
- Stars
- 474
- Forks
- 321
- Avg merge
- 23m
- Merged PRs (30d)
- 4
Description
I see that the go SDK has great API documentation (example).
The python SDK only provides rather useless text parts:
The value to assign to XXX of this YYY.
It would be great if also the python folks can benefit from good documentation.
Thanks!
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 comparing the Python SDK's generated field descriptions with the Go SDK example linked in the issue. Identify the documentation-generation entry point and the scope of affected API models; done means Python users receive meaningful property descriptions rather than repeated placeholder text.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100