Skip to content

Commit

Permalink
doc: the first line should be a simple sentence instead of a heading
Browse files Browse the repository at this point in the history
This is a writing style enforced in The Rust Standard Library.
  • Loading branch information
weihanglo committed Jun 3, 2023
1 parent b0fa796 commit 92c9d70
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 9 deletions.
5 changes: 4 additions & 1 deletion src/cargo/core/compiler/fingerprint/mod.rs
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
//! # Fingerprints
//! Tracks changes to determine if something needs to be recompiled.
//!
//! This module implements change-tracking so that Cargo can know whether or
//! not something needs to be recompiled. A Cargo [`Unit`] can be either "dirty"
//! (needs to be recompiled) or "fresh" (it does not need to be recompiled).
//!
//! ## Mechanisms affecting freshness
//!
//! There are several mechanisms that influence a Unit's freshness:
//!
//! - The [`Fingerprint`] is a hash, saved to the filesystem in the
Expand Down
2 changes: 1 addition & 1 deletion src/cargo/core/compiler/unit_dependencies.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
//! # Constructs the dependency graph for compilation
//! Constructs the dependency graph for compilation.
//!
//! Rust code is typically organized as a set of Cargo packages. The
//! dependencies between the packages themselves are stored in the
Expand Down
2 changes: 1 addition & 1 deletion src/cargo/core/profiles.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
//! # Profiles: built-in and customizable compiler flag presets
//! Handles built-in and customizable compiler flag presets.
//!
//! [`Profiles`] is a collections of built-in profiles, and profiles defined
//! in the root manifest and configurations.
Expand Down
3 changes: 2 additions & 1 deletion src/cargo/core/resolver/features.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
//! # Feature resolver
//! Resolves conditional compilation for [`features` section] in the manifest.
//!
//! This is a [new feature resolver] that runs independently of the main
//! dependency resolver. It has several options which can enable new feature
Expand Down Expand Up @@ -34,6 +34,7 @@
//!
//! There are probably other assumptions that I am forgetting.
//!
//! [`features` section]: https://doc.rust-lang.org/nightly/cargo/reference/features.html
//! [new feature resolver]: https://doc.rust-lang.org/nightly/cargo/reference/resolver.html#feature-resolver-version-2
//! [`resolve_ws_with_opts`]: crate::ops::resolve_ws_with_opts

Expand Down
6 changes: 2 additions & 4 deletions src/cargo/ops/cargo_compile/mod.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
//! # The Cargo "compile" operation
//!
//! This module contains the entry point for starting the compilation process
//! for commands like `build`, `test`, `doc`, `rustc`, etc.
//! The entry point for starting the compilation process for commands like
//! `build`, `test`, `doc`, `rustc`, etc.
//!
//! The [`compile`] function will do all the work to compile a workspace. A
//! rough outline is:
Expand Down
2 changes: 1 addition & 1 deletion src/cargo/util/profile.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
//! # An internal profiler for Cargo itself
//! An internal performance profiler for Cargo itself.
//!
//! > **Note**: This might not be the module you are looking for.
//! > For information about how Cargo handles compiler flags with profiles,
Expand Down

0 comments on commit 92c9d70

Please sign in to comment.