Doc Improvements

1

While I agree that the Rust generated doc is great, I still often find it annoying. I often elatedly click on a promising-sounding function on the left, only to see that it is unsafe, experimental and/or deprecated. I consider these off limits for production code, so I hardly want to be distracted by them.

  • I suggest extending the cog-wheel options to allow hiding them. This can (mostly) even be done in pure CSS (e.g. checkbox hack.)

  • Independently of this, I would give them different colours, e.g. red instead of green for unsafe (with some colour-blind-workaround) both in the doc and in the sidebar.

  • Also I would give them their respective icon(s) :fire::microscope::-1: in the sidebar as well.

A lesser gripe are the trait impls, which often consist of mostly signatures with scant text. Since the impl header hardly stands out, this looks chaotic. I would either indent everything under a common heading and/or give it a slightly different background colour.

2 Likes
2

You might want to repost this on IRLO instead. It is the forum where potential enhancements to the language or the tooling that you propose are discussed. There is also t-rustoc on Zulip, but I think IRLO would be better suited for discussion.

1 Like
3

Right you are! Done

4

This topic was automatically closed 90 days after the last reply. We invite you to open a new topic if you have further questions or comments.