Skip to content

Commit

Permalink
Add warning about stability to doc comment for internals module (#648)
Browse files Browse the repository at this point in the history
As discussed in #610 it probably makes sense to be explicit about the
`internals` module not being guaranteed to be stable.

I also noticed that `TextSnapshotKind` gets exposed globally. This was
added in #581 when it was still called `SnapshotKind`. I wonder if this
is necessary to expose toplevel.
  • Loading branch information
lasernoises authored Oct 7, 2024
1 parent 53dc3de commit ad7baa6
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions insta/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -300,6 +300,9 @@ pub use crate::snapshot::{MetaData, Snapshot, TextSnapshotKind};
///
/// You're unlikely to want to work with these objects but they
/// are exposed for documentation primarily.
///
/// This module does not follow the same stability guarantees as the rest of the crate and is not
/// guaranteed to be compatible between minor versions.
pub mod internals {
pub use crate::content::Content;
#[cfg(feature = "filters")]
Expand Down

0 comments on commit ad7baa6

Please sign in to comment.