about summary refs log tree commit diff
diff options
context:
space:
mode:
authorMatthias Krüger <matthias.krueger@famsik.de>2024-09-02 04:19:29 +0200
committerGitHub <noreply@github.com>2024-09-02 04:19:29 +0200
commit8c2898989f9a107c5c09a9f185e8fc5d4eb90b85 (patch)
tree7f40b5308d9bea02c70d01c897dc3347ed563250
parentdce26656eab3a3d42fde9bf337c3016ff5dc5efa (diff)
parent0064bd1b994b22093c6e7960818351ae65e0d183 (diff)
downloadrust-8c2898989f9a107c5c09a9f185e8fc5d4eb90b85.tar.gz
rust-8c2898989f9a107c5c09a9f185e8fc5d4eb90b85.zip
Rollup merge of #129793 - lolbinarycat:doc-missing-newlines, r=workingjubilee
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
-rw-r--r--library/core/src/hint.rs1
-rw-r--r--library/core/src/primitive_docs.rs5
2 files changed, 4 insertions, 2 deletions
diff --git a/library/core/src/hint.rs b/library/core/src/hint.rs
index 6ca5e53df3b..a69f0afdb0a 100644
--- a/library/core/src/hint.rs
+++ b/library/core/src/hint.rs
@@ -1,6 +1,7 @@
 #![stable(feature = "core_hint", since = "1.27.0")]
 
 //! Hints to compiler that affects how code should be emitted or optimized.
+//!
 //! Hints may be compile time or runtime.
 
 use crate::{intrinsics, ub_checks};
diff --git a/library/core/src/primitive_docs.rs b/library/core/src/primitive_docs.rs
index a7037b2a119..5451e45f6c8 100644
--- a/library/core/src/primitive_docs.rs
+++ b/library/core/src/primitive_docs.rs
@@ -832,8 +832,9 @@ mod prim_array {}
 #[doc(alias = "[")]
 #[doc(alias = "]")]
 #[doc(alias = "[]")]
-/// A dynamically-sized view into a contiguous sequence, `[T]`. Contiguous here
-/// means that elements are laid out so that every element is the same
+/// A dynamically-sized view into a contiguous sequence, `[T]`.
+///
+/// Contiguous here means that elements are laid out so that every element is the same
 /// distance from its neighbors.
 ///
 /// *[See also the `std::slice` module](crate::slice).*