Skip to content

Commit

Permalink
Resolve doc_lazy_continuation warnings in documentation
Browse files Browse the repository at this point in the history
Summary:
This lint caught a legit mistake in the documentation.

```lang=text,counterexample
error: doc list item missing indentation
  --> superconsole/src/lib.rs:20:5
   |
20 | //! Components live in the scratch area.
   |     ^
   |
   = help: if this is supposed to be its own paragraph, add a blank line
   = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html...
   = note: `-D clippy::doc-lazy-continuation` implied by `-D clippy::all`
   = help: to override `-D clippy::all` add `#[allow(clippy::doc_lazy_continuation)]`
help: indent this line
   |
20 | //!   Components live in the scratch area.
   |     ++
```

Without a blank line between the last bullet and next line, according to Markdown that sentence becomes part of the last bullet. Based on the content, it definitely does not seem like that was intended by the author of this documentation.

 {F1795256035}

Reviewed By: shayne-fletcher, JakobDegen

Differential Revision: D60933067

fbshipit-source-id: 7aba872b716c6351f000d77f44ac0e4b5f292765
  • Loading branch information
David Tolnay authored and facebook-github-bot committed Aug 8, 2024
1 parent 8661e88 commit 1498742
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,11 @@
//! User input will cause aberrations in output; similarly, one should also not produce output from other sources while superconsole is active.
//!
//! The rendering can be divided into two principle components:
//!
//! * In the *scratch* area, the previous content is overwritten at each render.
//!
//! * In the *emitted* area, lines scroll away above the scratch with various diagnostic output.
//!
//! Components live in the scratch area.
//!
//! A set of pre-baked composition and testing oriented components are provided in the [`components`] module.
Expand Down

0 comments on commit 1498742

Please sign in to comment.