berkus
/
miette
mirror of https://github.com/zkat/miette.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: dogfood url(docsrs)

This commit is contained in:
Kat Marchán 2021-08-22 15:59:27 -07:00
parent 7e76e2dea4
commit 2d886c06a3
No known key found for this signature in database
GPG Key ID: AEB529C08A3C7E9E
1 changed files with 4 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/error.rs
View File

@ -12,23 +12,21 @@ pub enum MietteError {
/// Wrapper around [std::io::Error]. This is returned when something went
/// wrong while reading a [crate::Source].
#[error(transparent)]
#[diagnostic(code(miette::io_error))]
#[doc(alias = "miette::io_error")]
#[diagnostic(code(miette::io_error), url(docsrs))]
IoError(#[from] io::Error),
/// Returned when a [crate::SourceSpan] extends beyond the bounds of a given [crate::Source].
#[error("The given offset is outside the bounds of its Source")]
#[diagnostic(
code(miette::span_out_of_bounds),
help("Double-check your spans. Do you have an off-by-one error?")
help("Double-check your spans. Do you have an off-by-one error?"),
url(docsrs)
)]
#[doc(alias = "miette::span_out_of_bounds")]
OutOfBounds,
/// Returned when installing a [crate::DiagnosticReportPrinter] failed.
/// Typically, this will be because [crate::set_printer] was called twice.
#[error("Failed to install DiagnosticReportPrinter")]
#[diagnostic(code(miette::set_printer_failed))]
#[doc(alias = "miette::set_printer_failed")]
#[diagnostic(code(miette::set_printer_failed), url(docsrs))]
SetPrinterFailure,
}