Attributes not in methods TOC?
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 930
- Forks
- 465
- Avg merge
- 3d 10h
- Merged PRs (30d)
- 27
Description
A class/module page documents its attributes in a section separate from that for its other instance methods. The TOC at the left links to the non-attribute methods, but not to the attribute-generated methods.
Internally, there seems to be no distinction between non-attribute methods and attribute-generated methods. Over at stackoverflow.com, queries about determining which way a method was defined go unanswered.
So my question is this: If an attribute-generated method is a full-fledged method, indistinquishable from a non-attribute method, should it not be in the left TOC?
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 reproducing the RDoc HTML output for a class or module with attribute-generated methods, then compare the attribute section with the other instance-method entries in the left TOC. Done means the intended treatment of attribute-generated methods is implemented consistently and covered by an appropriate RDoc test.
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