Skip to content

Commit 999b906

Browse files
committed
Add option style comment for rustc_optgroups
Signed-off-by: xizheyin <[email protected]>
1 parent d054690 commit 999b906

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

compiler/rustc_session/src/config.rs

+7
Original file line numberDiff line numberDiff line change
@@ -1665,6 +1665,13 @@ static EMIT_HELP: LazyLock<String> = LazyLock::new(|| {
16651665

16661666
/// Returns all rustc command line options, including metadata for
16671667
/// each option, such as whether the option is stable.
1668+
///
1669+
/// # Option style guidelines
1670+
///
1671+
/// - `<param>`: Indicates a required parameter
1672+
/// - `[param]`: Indicates an optional parameter
1673+
/// - `|`: Indicates a mutually exclusive option
1674+
/// - `*`: a list element with description
16681675
pub fn rustc_optgroups() -> Vec<RustcOptGroup> {
16691676
use OptionKind::{Flag, FlagMulti, Multi, Opt};
16701677
use OptionStability::{Stable, Unstable};

0 commit comments

Comments
 (0)