search

rust-embedded / embedded-hal

A Hardware Abstraction Layer (HAL) for embedded systems
Apache License 2.0
1.95k stars 197 forks source link

Doc: display issue #543

Closed HaoboGu closed 9 months ago

HaoboGu commented 10 months ago

In the doc of the latest version 1.0.0-rc.2, the indent of the first line is not correct:

1561153a638a4319265d8cbe2c156af8

The current version 0.2.7 looks good: image

It seems that crates.io doesn't support markdown grammar >.

Dirbaio commented 10 months ago

what's the issue? docs.rs and crates.io render > slightly different than github, by indenting the line instead of adding a bar to the left. Seems to be working as intended.

HaoboGu commented 9 months ago

My first impression was the indentation was wrong. There is nothing else different between a normal line and the > part, except the indentation, so it's difficult to distinguish > with four spaces.

If docs.rs renders > to indenting the line, should we prevent using > in documentation?

Dirbaio commented 9 months ago

I think this is a minor cosmetic issue. If you want to improve crates.io CSS, I'm sure they'd accept a PR.