Skip to content

Commit 06f6cd9

Browse files
committed
bootstrap: add doc-comments for ChangeSeverity
Signed-off-by: onur-ozkan <[email protected]>
1 parent d3d3eb9 commit 06f6cd9

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

Diff for: src/bootstrap/src/lib.rs

+3-1
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,10 @@ pub struct ChangeInfo {
8181

8282
#[derive(Clone, Debug)]
8383
pub enum ChangeSeverity {
84+
/// Used when build configurations continue working as before.
8485
Info,
86+
/// Used when the default value of an option changes, or support for an option is removed entirely,
87+
/// potentially requiring developers to update their build configurations.
8588
Warning,
8689
}
8790

@@ -96,7 +99,6 @@ impl ToString for ChangeSeverity {
9699

97100
/// Keeps track of major changes made to the bootstrap configuration.
98101
///
99-
///
100102
/// If you make any major changes (such as adding new values or changing default values),
101103
/// please ensure adding `ChangeInfo` to the end(because the list must be sorted by the merge date)
102104
/// of this list.

0 commit comments

Comments
 (0)