Support `:param:` and `:return:` tag directives, similar to YARD
Open
Nobody has claimed this yet.
Feature Request
- Dominant language
- Ruby
- Stars
- 930
- Forks
- 465
- Avg merge
- 3d 10h
- Merged PRs (30d)
- 27
Description
See YARD Tags doc for param and return.
This comes from a discussion in rails/rails#13989.
I'd like to define the api for this feature and provide support for the tags within the next minor release of RDoc. We don't have to add immediate support to darkfish, since we only need it for Rails and it can be implemented in SDoc.
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
Read the linked YARD Tags documentation for the param and return directives, then review the discussion in rails/rails#13989. Define the RDoc API for these tags and support them without requiring immediate darkfish changes; SDoc is the stated later implementation target.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100