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

Styling: Remove field block highlights and restore definition list indent #2425

Merged
merged 2 commits into from
Mar 14, 2022

Conversation

AA-Turner
Copy link
Member

@AA-Turner AA-Turner commented Mar 13, 2022

A

@AA-Turner
Copy link
Member Author

Copy link
Member

@CAM-Gerlach CAM-Gerlach left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately, this doesn't yet actually fix the problem reported in #2300 , and vertical margins are still pretty tight overall (as @pradyunsg reported), and there's also a contrast, consistency and accessibility issue with the changes to the header and footnotes styling. See comments for more on both and review suggestions to fix each of them.

Also, you might want to consider vertical rules between the definition list elements as well (perhaps --colour-rule-light ones) to help them and each element further stand out, and be a closer match to the original theme.

@@ -122,9 +122,6 @@ pre {
dl dt {
font-weight: bold;
}
dl dd {
margin: 0;
}

Copy link
Member

@CAM-Gerlach CAM-Gerlach Mar 13, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
dl dd {
margin-bottom: 0.5rem;
}

Unfortunately, this doesn't fix the problem reported in #2300 , where the vertical margin varies substantially between entries with multiple paragraphs (i.e, another <p> element) and those that only have one. Furthermore, the margins are still pretty tight as @pradyunsg reported, making them uncomfortable to read; they should be at least equivalent to the normal margin between paragraph-level elements.

See PEP 639 for an example:

image

This resolves both of those concerns by just ensuring that dl dd (except headers and footnotes, which are already overridden) have the same 0.5rem bottom vertical margin as paragraphs do:

image

Copy link
Member

@pradyunsg pradyunsg Mar 13, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's fix the line spacing in a follow up. It isn't limited to these dls. :)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are definitely other issues with line spacing, but this was one of the most immediately noticeable, and this particular issue is not just that the line spacing is too narrow but that is visibly inconsistent between definitions with multiple paragraphs and those with only a single one, so I'm not sure we should let the fact that there are also other issues with line spacing block fixing this one.

However, if we do this, this PR should be unmarked as resolving #2300 , because this was the initial problem that prompted and was cited in said issue.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Opened as #2427

pep_sphinx_extensions/pep_theme/static/style.css Outdated Show resolved Hide resolved
pep_sphinx_extensions/pep_theme/static/style.css Outdated Show resolved Hide resolved
@AA-Turner
Copy link
Member Author

I thought the issue with <dl> was the left margin (indent) -- if there are broader vertical whitespace proposed changes, I'd suggest them for a follow-up (per @pradyunsg's comment)

A

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

Successfully merging this pull request may close these issues.

5 participants