Skip to content

Commit 13e8352

Browse files
committed
Call out that we do not appear in public API
1 parent 86f6b3b commit 13e8352

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,11 @@ pub enum DataStoreError {
4444

4545
## Details
4646

47+
- Thiserror deliberately does not appear in your public API. You get the same
48+
thing as if you had written an implementation of `std::error::Error` by hand,
49+
and switching from handwritten impls to thiserror or vice versa is not a
50+
breaking change.
51+
4752
- Errors may be enums, structs with named fields, tuple structs, or unit
4853
structs.
4954

src/lib.rs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,11 @@
3131
//!
3232
//! # Details
3333
//!
34+
//! - Thiserror deliberately does not appear in your public API. You get the
35+
//! same thing as if you had written an implementation of `std::error::Error`
36+
//! by hand, and switching from handwritten impls to thiserror or vice versa
37+
//! is not a breaking change.
38+
//!
3439
//! - Errors may be enums, structs with named fields, tuple structs, or unit
3540
//! structs.
3641
//!

0 commit comments

Comments
 (0)