Python
/
ruff
mirror of https://github.com/astral-sh/ruff
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

ruff_db: clarify the error conditions of `Diagnostic::print`

This commit is contained in:
Andrew Gallant 2025-03-17 10:58:41 -04:00 committed by Andrew Gallant
parent 7512a71bbb
commit ff548b1272
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
crates/ruff_db/src/diagnostic/mod.rs
View File

@ -109,6 +109,20 @@ impl Diagnostic {
/// This also marks the diagnostic as having been printed. If a /// This also marks the diagnostic as having been printed. If a
/// diagnostic is not rendered this way, then it will panic when /// diagnostic is not rendered this way, then it will panic when
/// it's dropped when `debug_assertions` is enabled. /// it's dropped when `debug_assertions` is enabled.
///
/// # Defuses panics
///
/// When `debug_assertions` is enabled and a `Diagnostic` does
/// _not_ have this method called, then its `Drop` implementation
/// will panic. The intent of this panic is to avoid mistakes where
/// a diagnostic is created and then never printed. That is usually
/// indicative of a bug.
///
/// # Errors
///
/// This is guaranteed to only return an error if the underlying
/// writer given returns an error. Otherwise, the formatting of
/// diagnostics themselves is infallible.
pub fn print( pub fn print(
&mut self, &mut self,
db: &dyn Db, db: &dyn Db,