oceanbase / oceanbase/pyseekdb
[Enhancement]: format document string
Open
Nobody has claimed this yet.
type: enhancement
vibe coding: easy
- Dominant language
- Python
- Stars
- 62
- Forks
- 35
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 2
Description
Description
We can view the API document on website now, but there's some problems.
The format of some interfaces are bad, for example:
create_collection.
As there's too many problems, we should not fix them in one issue.
It's better to create a new issue for one interface.
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 at the create_collection API documentation shown on the website and inspect how its document string is rendered. Compare the current formatting with the surrounding API documentation, then confirm that create_collection displays correctly; the issue does not name a source file or test to run.
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