SimpleDelegator documentation missing in ruby-docs.org
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 25
- Forks
- 14
- Avg merge
- 8h 41m
- Merged PRs (30d)
- 1
Description
Since 3.0.0, the library documentation is only partially rendered. Neither SimpleDelegator nor
the DelegateClass kernel method appear in the documentation.
https://ruby-doc.org/stdlib-3.0.0/libdoc/delegate/rdoc/Delegator.html
https://ruby-doc.org/stdlib-3.0.1/libdoc/delegate/rdoc/Delegator.html
https://ruby-doc.org/stdlib-3.0.2/libdoc/delegate/rdoc/Delegator.html
I'm not sure if splitting it into one file per top-level definition would solve it, but it might be the case that ruby-docs does not support several top-level definitions in the same file?
Contributor guide
No contributing guide indexed for this repository
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 comparing the linked ruby-docs.org pages for delegate 3.0.0 through 3.0.2, then inspect how the delegate library's top-level definitions are rendered. The work is complete when SimpleDelegator and the DelegateClass kernel method appear in the generated documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100