Skip to content

Glossary: de-bold paragraph headers #192

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

Merged
merged 1 commit into from
Aug 15, 2019
Merged

Conversation

RalfJung
Copy link
Member

@RalfJung RalfJung commented Aug 6, 2019

Once #191 lands we can make them bold again, but currently this looks confusing.

@gnzlbg
Copy link
Contributor

gnzlbg commented Aug 6, 2019

Can't we just use headings for these ?

@RalfJung
Copy link
Member Author

RalfJung commented Aug 6, 2019

You mean fifth-level headings? Are those a thing?

Anyway I think the equivalent of LaTeX \paragraph makes more sense here.

@gnzlbg
Copy link
Contributor

gnzlbg commented Aug 6, 2019

You mean fifth-level headings? Are those a thing?

Yes that's what I meant. I don't think Markdown has any other way to encode these (unless one uses HTML labels?).

Anyway I think the equivalent of LaTeX \paragraph makes more sense here.

I don't know of any such thing in Markdown or mdbook.

@RalfJung
Copy link
Member Author

I don't know of any such thing in Markdown or mdbook.

I am emulating them with the italics here.

@Lokathor
Copy link
Contributor

Instead of starting with two # and then jumping to four #, just start with one and then use two or three for entries and then plus one level for sections within entries.

If a particular entry needs more than one level of sub-section it's complex enough to either get broken up or just made far more terse.

The glossary doesn't have to be exacting if the full definition is very long. Instead, we simply give a short description (enough to get the idea) and a link to the full story in a proper part of the book.

@RalfJung RalfJung mentioned this pull request Aug 14, 2019
4 tasks
@RalfJung
Copy link
Member Author

@Lokathor yes we want to change the global level, see #191. But that is blocked, so I wanted to land this in the interim.

@RalfJung
Copy link
Member Author

So, any objections for this small tweak to make the glossary more readable now without having to re-format everything?

@RalfJung RalfJung added the C-terminology Category: Discussing terminology -- which term to use, how to define it, adding it to the glossary label Aug 14, 2019
@gnzlbg gnzlbg merged commit 003eee9 into rust-lang:master Aug 15, 2019
@RalfJung RalfJung deleted the glossary-fmt branch August 28, 2019 11:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-terminology Category: Discussing terminology -- which term to use, how to define it, adding it to the glossary
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants