Skip to content

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

Open

Description

@adam12

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.

Activity

  1. st0012 commented on Jan 25, 2026

    @st0012
    Member

    Though attributes function the same as normal methods, they capture more context about the intention. And IMO that context should be captured in documentation, so they should NOT be treated as normal methods by RDoc.
    I lean towards listing attributes in the sidebar too, but I'd wait a bit to see what others think before making a PR.

  2. nevans commented on Mar 13, 2026

    @nevans
    Contributor

    As both a reader and a writer of rdoc, I've wanted attributes in the sidebar for years. Listing them separately, above regular methods, would be nice. But I'd personally rather attributes be listed as regular methods than not at all.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions