Skip to content

Commit b118abd

Browse files
Document semver guarantees regarding parser bugs and rust changes
1 parent f9bce2a commit b118abd

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

src/lib.rs

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,15 @@
129129
//! }
130130
//! ```
131131
//!
132+
//! # SemVer/Versioning guarantees
133+
//!
134+
//! Some technically breaking changes might be released as a minor/patch version
135+
//! in some situations, for example:
136+
//! - Bugs in this library (e.g. behavior different from rustc)
137+
//! - Rust making breaking changes, likely via new edition
138+
//!
139+
//! In all cases, releasing these changes as a minor/patch version is only done
140+
//! if it is expected that breakage is minimal or non-existent.
132141
//!
133142
//!
134143
//! # Crate features

0 commit comments

Comments
 (0)