Stream: t-lang/wg-unsafe-code-guidelines

Topic: Glossary


RalfJ (Jul 26 2019 at 09:47, on Zulip):

@Lokathor btw, we have like 3 or 4 PRs open that edit the glossary, so I think it'll be a while until you can do the alphabetic reordering

RalfJ (Jul 26 2019 at 09:48, on Zulip):

also I am not sold on your idea to wrap it to 80 lines. I am a big fan of one-sentence-per line for LaTeX and markdown sources. it makes the diff much more meaningful.

Lokathor (Jul 27 2019 at 07:18, on Zulip):

Well that's fine if you want to go that route
most people don't look at the raw markdown anyway, so it's not a big deal. I just like wrapped paragraphs when looking at it in my editor because code and code comments are also generally wrapped, and so text overall is a little more consistent that way

RalfJ (Jul 27 2019 at 07:24, on Zulip):

yeah it's a somewhat arbitrary decision either way. I am writing a lot of LaTeX these days and just format my markdown the same when tidy does not prevent me from it. ;)

Lokathor (Jul 27 2019 at 07:28, on Zulip):

alright we'll skip on wrapping and just do alphabetization once the glossary settles down

RalfJ (Jul 28 2019 at 21:13, on Zulip):

speaking of which, I think we should also make the items of the glossary into ### headers. right now we use #### and that has the same font size as **bold text**, which makes this look confusing: https://github.com/rust-lang/unsafe-code-guidelines/blob/master/reference/src/glossary.md#pointer-provenance

RalfJ (Jul 28 2019 at 21:13, on Zulip):

"Using provenance to track originating allocation" is a sub-header, and "Interior mutability" is the next actual header, but they have the same size and font...

RalfJ (Jul 28 2019 at 21:14, on Zulip):

glossary PRs currently open:
https://github.com/rust-lang/unsafe-code-guidelines/pull/153
https://github.com/rust-lang/unsafe-code-guidelines/pull/180

gnzlbg (Jul 29 2019 at 12:34, on Zulip):

"Using provenance to track originating allocation" is a sub-header, and "Interior mutability" is the next actual header, but they have the same size and font...

We should open an issue with mdbook, and ask whether there is something that can be done about it at that level, or what would be the simplest way for us to tune it.

I somehow would expect the ###...s to be translated to <hN> html tags, but maybe something cleverer is going on ? If these actually generate <hN> tags, then its actually an issue that has to be filled with your web-browser, since for 2 different Ns, those shouldn't be rendered equally.

RalfJ (Jul 29 2019 at 13:14, on Zulip):

my guess is the style just makes the h4 (or whatever #### ends up as) the same size as normal text

Last update: Nov 19 2019 at 18:40UTC