ruby / rdoc

RDoc produces HTML and online documentation for Ruby projects.
https://ruby.github.io/rdoc/
Other
844 stars 440 forks source link

Use the original `label` description list style #1208

Open nevans opened 1 week ago

nevans commented 1 week ago

As a default for all description lists, the original "label" style is more readable.

This is slightly different from the original label dl though:

See the discussion at #1199. Because of that discussion, this PR gives both description lists the "label" style. A different PR (#1209) would also bring back distinct styling for the "note" list.

nevans commented 1 week ago

Here are some screenshots. Please note that I did add a second dt to both of the examples, because I think it's important to see how that displays too. I didn't add it to the examples, but I'm happy to add that to this PR or to make another PR for it.

v6.7.0:

Screenshot 2024-11-15 at 09-52-02 ExampleRDoc - rdoc 6 7 0 Documentation

current master:

Screenshot 2024-11-15 at 09-50-58 ExampleRDoc - rdoc Documentation

This PR:

Screenshot 2024-11-15 at 09-50-22 ExampleRDoc - rdoc Documentation

nevans commented 1 week ago

I'll make a separate PR to bring back a distinct "note" style, so that can be judged separately from this. 🙂 But I also want to tweak some of the styling issues that I dislike about the original, so I might not get to it until later today.