Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use the original label description list style #1208

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

nevans
Copy link
Contributor

@nevans nevans commented Nov 15, 2024

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

This is slightly different from the original label dl though:

  • slightly increase left margin for dd (to 1em)
  • remove right margin on dd
  • remove dt bottom margin and dd top margin, to reduce the gap between the term and its description to only the standard line-height gap

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.

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

This is slightly different from the original `label` dl though:
* slightly increased left margin for `dd` (to 1em)
* removed right margin on `dd`
* removed `dt` bottom margin and `dd` top margin, to reduce the gap
  between the term and its description (to only the standard line-height
  gap).
@nevans
Copy link
Contributor Author

nevans commented Nov 15, 2024

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
Copy link
Contributor Author

nevans commented Nov 15, 2024

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.

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

Successfully merging this pull request may close these issues.

1 participant