Skip to content

Commit 4e3dbee

Browse files
lolbinarycatworkingjubilee
authored andcommitted
add extra linebreaks so rustdoc can identify the first sentence
there should probably be a lint against this in rustdoc, it causes too many lines to be shown in the short documentation overviews expecially noticable for the slice primative type: https://doc.rust-lang.org/std/index.html
1 parent 7c1560f commit 4e3dbee

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

Diff for: core/src/hint.rs

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
#![stable(feature = "core_hint", since = "1.27.0")]
22

33
//! Hints to compiler that affects how code should be emitted or optimized.
4+
//!
45
//! Hints may be compile time or runtime.
56
67
use crate::{intrinsics, ub_checks};

Diff for: core/src/primitive_docs.rs

+3-2
Original file line numberDiff line numberDiff line change
@@ -832,8 +832,9 @@ mod prim_array {}
832832
#[doc(alias = "[")]
833833
#[doc(alias = "]")]
834834
#[doc(alias = "[]")]
835-
/// A dynamically-sized view into a contiguous sequence, `[T]`. Contiguous here
836-
/// means that elements are laid out so that every element is the same
835+
/// A dynamically-sized view into a contiguous sequence, `[T]`.
836+
///
837+
/// Contiguous here means that elements are laid out so that every element is the same
837838
/// distance from its neighbors.
838839
///
839840
/// *[See also the `std::slice` module](crate::slice).*

0 commit comments

Comments
 (0)