rustdoc: kbd style rules

[hellow554]

Hi everyone,

I documented a struct which uses keyboard commands during runtime to do something and I noticed that it looks not as nice as it could be, so I looked around and compared different kbd styles on the internet.
I compare here the github style (A), Stackexchange and Bootstrap (v4)

Which of these styles do you prefer? I would go with the github style, because it's looks nice and clean without any padding. Maybe one could increase the font size.

I would also do a PR, but I wanted to discuss the style before I do that.

So, what are your thoughts? Do you have any different style in mind? To which elements should the rule apply? To all <kbd> tags or just tags inside a docblock?

[GuillaumeGomez]

What prevents you to add your own style in your crate doc? Because I'm not sure to understand why we'd want that...

[GuillaumeGomez]

cc @rust-lang/docs

[steveklabnik]

I also prefer the github style.

@GuillaumeGomez to me, this is a regular old HTML element; we should give it a decent style.

[QuietMisdreavus]

👍 for the github style.

[frewsxcv]

github style looks most like a keyboard key to me, so i'd be favor of that too

[hellow554]

Thank you for your responses <3 what about the rule? Every <kbd> tag or just the ones inside a docblock ?

[QuietMisdreavus]

I'd say to make it every <kbd> tag, so we can also change the ? help menu to use them as well.

[steveklabnik]

Agreed!

[GuillaumeGomez]

I extend a bit my statement: I'm opposed to this add because it'll be used in too few cases to be interesting to grow the CSS files (I could bet on maximum 5 people, which is just way too low). It doesn't bring anything useful enough to justify any new content. Please remember that new content means more maintenance.

Adding a CSS rule in your own doc crate is far easier and better for everyone in most cases. If we add such a style for an element which is almost never used, should we add a style for every HTML tag as well? Of course not! This is way too specific and it's up to crates' owners, not to rustdoc.

cc @rust-lang/docs

[hellow554]

I may understand your concern, but do not share your opinion.

A tag is just a tag, and kbd should be used to represent input from a keyboard and for that it should be visualized as such. It's not about adding bloat to the css, but to give a nice visual hint to the reader, that this is a keyboard input.

[QuietMisdreavus]

I already mentioned a place where rustdoc can use a <kbd> style for itself - the help menu. Right now it's skinning <dt> to get it, but it can move to use <kbd> tags and get a better style for it if we add it.

[GuillaumeGomez]

If the PR does the switch (aka removing dt tag and style). Then it's good for me. As long as it's used by rustdoc, no problem.