Skip to content

Commit

Permalink
Auto merge of #10077 - not-fl3:profile_checking_doc_comments, r=Eh2406
Browse files Browse the repository at this point in the history
Make ProfileChecking comments a doc comments

A little PR that makes rustdoc render comments for ProfileChecking struct.

Before:
![image](https://user-images.githubusercontent.com/910977/141529033-34bca263-abb1-4a1d-8e13-3c42edc2189e.png)

After:
![image](https://user-images.githubusercontent.com/910977/141529011-756ac54f-c0b2-4c03-bdb6-c9434e00afe5.png)
  • Loading branch information
bors committed Nov 12, 2021
2 parents e11cd81 + 4dc7d08 commit 6f76db6
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions src/cargo/util/command_prelude.rs
Original file line number Diff line number Diff line change
Expand Up @@ -287,15 +287,15 @@ pub fn subcommand(name: &'static str) -> App {
])
}

// Determines whether or not to gate `--profile` as unstable when resolving it.
/// Determines whether or not to gate `--profile` as unstable when resolving it.
pub enum ProfileChecking {
// `cargo rustc` historically has allowed "test", "bench", and "check". This
// variant explicitly allows those.
/// `cargo rustc` historically has allowed "test", "bench", and "check". This
/// variant explicitly allows those.
LegacyRustc,
// `cargo check` and `cargo fix` historically has allowed "test". This variant
// explicitly allows that on stable.
/// `cargo check` and `cargo fix` historically has allowed "test". This variant
/// explicitly allows that on stable.
LegacyTestOnly,
// All other commands, which allow any valid custom named profile.
/// All other commands, which allow any valid custom named profile.
Custom,
}

Expand Down

0 comments on commit 6f76db6

Please sign in to comment.