Consider displaying accessors (`Attributes`) in sidebar or merging with Instance Methods

Open
#1,579 2 comments 1 reaction 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
ruby
Domain
documentation

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.

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.

Dominant language
Ruby
Stars
930
Forks
472
Avg merge
2d 8h
Merged PRs (30d)
12

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from ruby/rdoc

All issues in ruby/rdoc

Similar issues

More Ruby issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.