ydb-platform / ydb-platform/ydb-python-sdk
dev: docs for DriverConfig
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Python
- Stars
- 102
- Forks
- 75
- Avg merge
- 1d 23h
- Merged PRs (30d)
- 13
Description
It would be useful to have a complete description, types, and examples for database connection configuration (ydb.DriverConfig). As well as other settings RetrySettings, PublicReaderSettings and others
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 locating the definitions and existing documentation for ydb.DriverConfig, RetrySettings, PublicReaderSettings, and related settings. Document their complete descriptions, types, and configuration examples, then verify that the documentation covers the requested database connection settings.
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
- 45/100