proposal: include "added in version X.X" to api docs
Open
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 118
- Forks
- 161
- PR merge metrics
- No merged PRs in 30d
Description
Right now it's difficult to know exactly which features are available based on the version of the database/drivers you're using. A lot of projects solve this by adding a note to functions to explain when they were added/modified.
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 API documentation and the database/driver version history. Determine which functions need version notes and document the agreed scope; done means the affected API entries consistently state when features were added or modified.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100