Three public Result-returning functions are missing # Errors sections in their doc comments, triggering clippy's missing_panics_doc / doc documentation lints:
| Function |
File |
Line |
render_gitlab_quality_json |
gitlab_quality.rs |
86 |
render_sarif_json |
sarif.rs |
230 |
render_sensor_json |
sensor.rs |
134 |
Problem: Per Rust API Guidelines C409, public functions returning Result should document their error conditions in an # Errors section. Without this, callers have no guaranteed understanding of when and how these functions can fail.
Fix: Add an # Errors section to each doc comment documenting the serde_json::Error failure condition. For example:
/// # Errors
///
/// Returns an error if JSON serialization fails.
pub fn render_gitlab_quality_json(receipt: &CheckReceipt) -> Result<String, serde_json::Error> {
Priority: Low — these are stable APIs whose error cases are unlikely to change, but the missing docs are a correctness gap.
Three public
Result-returning functions are missing# Errorssections in their doc comments, triggering clippy'smissing_panics_doc/ doc documentation lints:render_gitlab_quality_jsongitlab_quality.rsrender_sarif_jsonsarif.rsrender_sensor_jsonsensor.rsProblem: Per Rust API Guidelines C409, public functions returning
Resultshould document their error conditions in an# Errorssection. Without this, callers have no guaranteed understanding of when and how these functions can fail.Fix: Add an
# Errorssection to each doc comment documenting theserde_json::Errorfailure condition. For example:Priority: Low — these are stable APIs whose error cases are unlikely to change, but the missing docs are a correctness gap.