http-rs / surf

Fast and friendly HTTP client framework for async Rust
https://docs.rs/surf
Apache License 2.0
1.45k stars 119 forks source link

docs.rs: newlines in docstrings? #257

Open aldanor opened 3 years ago

aldanor commented 3 years ago

Not a critical thing, but an annoyance that I haven't see for other crates, not sure why it's happening here.

Example: https://docs.rs/surf/2.1.0/src/surf/client.rs.html - where do those newlines in docstrings appear from?

image

This breaks line numbering in source docs, as they end like this:

image

goto-bus-stop commented 3 years ago

Doc comment lines are wrapped in a <span class="doccomment"> on docs.rs. Looks like the HTML contains a \r before the closing </span>, and \n between spans. Maybe an issue with crates published from Windows machines?

Fishrock123 commented 3 years ago

Huh. Yes, @goto-bus-stop is correct, this was last published from my Windows desktop.