Marcono1234 / struson

Streaming JSON reader and writer written in Rust
https://crates.io/crates/struson
Apache License 2.0
64 stars 6 forks source link

Use trailing `\` instead of two spaces for hard line break in Markdown #30

Closed Marcono1234 closed 10 months ago

Marcono1234 commented 10 months ago

Problem solved by the enhancement

Currently the Markdown files and Rust doc comments in this repository use two trailing spaces for hard line breaks. This is easy to overlook and not very obvious.

However, at least CommonMark also supports a trailing \ to create a hard line break, see the specification, which makes the intention more obvious.

Enhancement description

Verify that rustdoc supports a trailing \ for hard line breaks. Then use it instead of two spaces in Markdown files and Rust doc comments.