1392857 - Provide special styling for nested <DL>s

Status: RESOLVED WONTFIX

(developer.mozilla.org Graveyard :: Design, enhancement, P3)

Description

[Eric Shepherd [:sheppy]]

We use nested definition lists at times when documenting an API; for example, in a parameter list in which a parameter is an object with several fields (see https://developer.mozilla.org/en-US/docs/Web/API/PromiseRejectionEvent/PromiseRejectionEvent for example).

The readability of the nested <dl> is a little off: it's crammed up against the parent <dd>, has a lot of spacing between the items, and fails to stand out as being associated with the previous <dt><dd> pair.

A second-level <dl> should have a different appearance, either automatically or through a style the writer can choose to apply. At least adjust the line spacing a bit and possibly indent the <dl> slightly, or even consider some kind of outline or other visual cue to attach the information to the parent <dd>.

See https://screenshots.firefox.com/4ucBrrg9cI65tUpK/developer.mozilla.org for a screenshot of what it looks like now.

Here's a screenshot of the vague concept I'm talking about (with apologies, it's just a quick mockup):

https://screenshots.firefox.com/zbv8R7bel1ChLvgN/developer.mozilla.org

Comment 1

[John Whitlock [:jwhitlock]]

Can you add these as attachments rather than images hosted on screenshots.firefox.com?

Comment 2

[Eric Shepherd [:sheppy]]

Attachment: Screenshot: What it currently looks like

Comment 3

[Eric Shepherd [:sheppy]]

Attachment: Screenshot: Idea for a new appearance

Comment 4

[Eric Shepherd [:sheppy]]

I've attached the screenshots.

Comment 5

[BMO Automation]

MDN Web Docs' bug reporting has now moved to GitHub. From now on, please file content bugs at https://github.com/mdn/sprints/issues/ and platform bugs at https://github.com/mdn/kuma/issues/.