Consider displaying accessors (`Attributes`) in sidebar or merging with Instance Methods
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 930
- Forks
- 465
- Avg merge
- 3d 10h
- Merged PRs (30d)
- 27
Description
Certain classes contain a collection of useful instance methods that become less visible due to their status as accessors, leading to their omission from the sidebar.
For instance, Net::HTTP includes various configuration options for the SSL context, such as ca_cert, cert, and key. However, these options are located towards the bottom of the main viewport, making them less easily discoverable.
Listing them in the sidebar would enhance their visibility and accessibility.
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 generating RDoc output for Net::HTTP and inspect how its sidebar distinguishes accessors from instance methods. Compare the sidebar with the main method listing, then verify that accessor methods such as ca_cert, cert, and key are discoverable in the sidebar or merged into the instance-method section.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100