Skip to content
This repository was archived by the owner on Aug 16, 2021. It is now read-only.

Commit 5aeefd7

Browse files
committed
Hide implementation details from the doc.
1 parent c39d242 commit 5aeefd7

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

src/lib.rs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -673,6 +673,7 @@ impl<'a> Iterator for ErrorChainIter<'a> {
673673
/// is set to anything but ``0``, and `None` otherwise. This is used
674674
/// in the generated error implementations.
675675
#[cfg(feature = "backtrace")]
676+
#[doc(hidden)]
676677
pub fn make_backtrace() -> Option<Arc<Backtrace>> {
677678
match std::env::var_os("RUST_BACKTRACE") {
678679
Some(ref val) if val != "0" => Some(Arc::new(Backtrace::new())),
@@ -681,12 +682,13 @@ pub fn make_backtrace() -> Option<Arc<Backtrace>> {
681682
}
682683

683684
#[cfg(not(feature = "backtrace"))]
685+
#[doc(hidden)]
684686
pub fn make_backtrace() -> Option<Arc<Backtrace>> {
685687
None
686688
}
687689

688-
/// This trait is an implementation detail, you should have to implement or
689-
/// use it.
690+
/// This trait is an implementation detail which must be implemented on each
691+
/// ErrorKind. We can't do it globally since each ErrorKind is different.
690692
pub trait Error: error::Error + Send + 'static {
691693
/// Associated kind type.
692694
type ErrorKind;

0 commit comments

Comments
 (0)