Add a directive to track "since" version information
Open
Nobody has claimed this yet.
Feature Request
- Dominant language
- Ruby
- Stars
- 930
- Forks
- 465
- Avg merge
- 3d 10h
- Merged PRs (30d)
- 27
Description
It can be useful when reading documentation to know in which version a method was first available. For example, when looking at Ruby's Enumerable#max_by latest documentation and wanting to know when it was first available.
A :since: <version> directive would support this.
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
No files or tests are named. Start by tracing how existing RDoc directives are parsed and rendered, then inspect related directive tests. Done means a :since: directive is supported and its version information appears in generated documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100