Skip to content

Commit 57326f5

Browse files
committed
Auto merge of #12228 - weihanglo:doc-style, r=epage
doc: the first line should be a simple sentence instead of a heading This is a writing style enforced in The Rust Standard Library.
2 parents b0fa796 + 92c9d70 commit 57326f5

File tree

6 files changed

+11
-9
lines changed

6 files changed

+11
-9
lines changed

src/cargo/core/compiler/fingerprint/mod.rs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
1-
//! # Fingerprints
1+
//! Tracks changes to determine if something needs to be recompiled.
22
//!
33
//! This module implements change-tracking so that Cargo can know whether or
44
//! not something needs to be recompiled. A Cargo [`Unit`] can be either "dirty"
55
//! (needs to be recompiled) or "fresh" (it does not need to be recompiled).
6+
//!
7+
//! ## Mechanisms affecting freshness
8+
//!
69
//! There are several mechanisms that influence a Unit's freshness:
710
//!
811
//! - The [`Fingerprint`] is a hash, saved to the filesystem in the

src/cargo/core/compiler/unit_dependencies.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! # Constructs the dependency graph for compilation
1+
//! Constructs the dependency graph for compilation.
22
//!
33
//! Rust code is typically organized as a set of Cargo packages. The
44
//! dependencies between the packages themselves are stored in the

src/cargo/core/profiles.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! # Profiles: built-in and customizable compiler flag presets
1+
//! Handles built-in and customizable compiler flag presets.
22
//!
33
//! [`Profiles`] is a collections of built-in profiles, and profiles defined
44
//! in the root manifest and configurations.

src/cargo/core/resolver/features.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! # Feature resolver
1+
//! Resolves conditional compilation for [`features` section] in the manifest.
22
//!
33
//! This is a [new feature resolver] that runs independently of the main
44
//! dependency resolver. It has several options which can enable new feature
@@ -34,6 +34,7 @@
3434
//!
3535
//! There are probably other assumptions that I am forgetting.
3636
//!
37+
//! [`features` section]: https://doc.rust-lang.org/nightly/cargo/reference/features.html
3738
//! [new feature resolver]: https://doc.rust-lang.org/nightly/cargo/reference/resolver.html#feature-resolver-version-2
3839
//! [`resolve_ws_with_opts`]: crate::ops::resolve_ws_with_opts
3940

src/cargo/ops/cargo_compile/mod.rs

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
1-
//! # The Cargo "compile" operation
2-
//!
3-
//! This module contains the entry point for starting the compilation process
4-
//! for commands like `build`, `test`, `doc`, `rustc`, etc.
1+
//! The entry point for starting the compilation process for commands like
2+
//! `build`, `test`, `doc`, `rustc`, etc.
53
//!
64
//! The [`compile`] function will do all the work to compile a workspace. A
75
//! rough outline is:

src/cargo/util/profile.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! # An internal profiler for Cargo itself
1+
//! An internal performance profiler for Cargo itself.
22
//!
33
//! > **Note**: This might not be the module you are looking for.
44
//! > For information about how Cargo handles compiler flags with profiles,

0 commit comments

Comments
 (0)