http-rs / http-rs/surf

docs.rs: newlines in docstrings?

Open
#257 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
Rust
Stars
1.5k
Forks
128
PR merge metrics
No merged PRs in 30d

Description

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](https://user-images.githubusercontent.com/2418513/97970103-ec440200-1db8-11eb-966e-7d3413527e78.png)

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

![image](https://user-images.githubusercontent.com/2418513/97970172-067de000-1db9-11eb-8f6b-1ab0e10eb589.png)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.