Aliki: Hard to discern method blocks visually

Open
#1,573 2 comments 0 reactions 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

Research direction

Start by reproducing the reported method documentation and right sidebar in RDoc's generated HTML, using the screenshots as the visual reference. Trace how method names, Args, and Description entries are rendered and identify the relevant templates or styles. Done means method boundaries are visually clear and sidebar entries indicate the method they belong to.

Written by the indexing model from the issue text.

Description

I find it really hard to see where a method documentation starts and ends:

Image

The headers "Args" and "Description" are much bigger than the method name although they are subordinate to it. This means when scrolling through the page it is hard - at least for me - to discern the part that belongs to a method.

I'm not sure whether this is the same problem but the right side bar is also quite useless in this case:

Image

It is just a list of "Args" and "Description" entries without a hint for what.

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.