docs: fix

Author: Frando

README.md

@@ -1,8 +1,14 @@
 # n0-error
 
-**Experimental / Work in progress**
+An error library that supports tracking the call-site location of errors.
 
-A error library that supports tracking the call-site location of errors. Also features an anyhow-style `AnyError`.
+This crate provides a trait and proc macro to ergonomically work with enum or struct errors. The macro can add
+a `meta` field to structs and enum variants, which stores the call-site location of errors. The `StackError`
+trait provides access to this metadata for both the current error, and all its sources, as long as they also
+implement `StackError`.
+
+Additionally, this crate provides an anyhow-style `AnyError` type, which is a type-erased container for either
+`StackError` or `std::error::Error` errors.
 
 ```rust
 use n0_error::{e, stack_error, StackError, Result, StackResultExt, StdResultExt};

src/any.rs

@@ -12,7 +12,7 @@ use crate::{ErrorRef, FromString, Meta, SourceFormat, StackError, StackErrorExt}
 /// their call-site location info.
 ///
 /// Errors that implement [`std::error::Error`] but not [`StackError`] can't convert to
-/// [`AnyError`] automatically. Use either [`AnyError::from_std`] or [`crate::StdResultExt::e`]
+/// [`AnyError`] automatically. Use either [`AnyError::from_std`] or [`crate::StdResultExt::anyerr`]
 /// to convert std errors into [`AnyError`].
 ///
 /// This is necessary unfortunately because if we had a blanket conversion from std errors to `AnyError`,

src/lib.rs

@@ -1,10 +1,3 @@
-//! Ergonomic error handling with call-site location tracking.
-//!
-//! This crate provides tools for efficient and ergonomic error handling with support
-//! for tracking the call-site location of errors.
-//!
-//! Inspired by anyhow, thiserror, and snafu.
-
 #![doc = include_str!("../README.md")]
 #![deny(missing_docs)]
 

src/macros.rs

@@ -41,6 +41,13 @@ pub use spez as __spez;
 /// The forms that take `value` use *autoref specialization* to keep the most details possible:
 /// if given a [`StackError`] it uses [`AnyError::from_stack`], if given a std error, uses [`AnyError::from_std`],
 /// if given a value that impls `Display` it uses [`AnyError::from_display`] - in this order.
+///
+/// [`AnyError::context`]: crate::AnyError::context
+/// [`AnyError::from_display`]: crate::AnyError::from_display
+/// [`AnyError::from_stack`]: crate::AnyError::from_stack
+/// [`AnyError::from_std`]: crate::AnyError::from_std
+/// [`AnyError`]: crate::AnyError
+/// [`StackError`]: crate::StackError
 #[macro_export]
 macro_rules! anyerr {
     ($fmt:literal$(, $($arg:expr),* $(,)?)?) => {
@@ -92,6 +99,9 @@ macro_rules! ensure {
 /// to `false`, the macro expands to returning an error result. The error will be constructed
 /// by passing the remaining arguments after the expression to [`anyerr`]. See its docs for
 /// supported forms.
+///
+/// [`AnyError`]: crate::AnyError
+/// [`anyerr`]: crate::anyerr
 #[macro_export]
 macro_rules! ensure_any {
     ($cond:expr, $($tt:tt)*) => {
@@ -116,6 +126,9 @@ macro_rules! bail {
 ///
 /// This macro accepts the same forms as [`anyerr`], but wraps the error into `Err` and
 /// expands to returning the result from the current function.
+///
+/// [`AnyError`]: crate::AnyError
+/// [`anyerr`]: crate::anyerr
 #[macro_export]
 macro_rules! bail_any {
     ($($tt:tt)*) => {
@@ -143,6 +156,8 @@ macro_rules! try_or {
 ///
 /// If the result is the error variant, this will construct a new error with [`anyerr`]
 /// from the result's error while providing additional context.
+///
+/// [`anyerr`]: crate::anyerr
 #[macro_export]
 macro_rules! try_or_any {
     ($result:expr, $($context:tt)*) => {