Skip to content

Commit

Permalink
Merge pull request #49 from AndersTrier/AndersTrier/clippy_doc_comment
Browse files Browse the repository at this point in the history
Fix Clippy lint: "first doc comment paragraph is too long"
  • Loading branch information
AndersTrier authored Oct 3, 2024
2 parents 51eeb1d + 8ed21b9 commit 95ddaf8
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions src/engine.rs
Original file line number Diff line number Diff line change
Expand Up @@ -93,12 +93,11 @@ pub type GfElement = u16;
// ======================================================================
// Engine - PUBLIC

/// Implementation of compute-intensive low-level algorithms needed
/// for Reed-Solomon encoding/decoding. This is the trait you would
/// implement to provide SIMD support for a CPU architecture not
/// already provided.
/// Trait for compute-intensive low-level algorithms needed
/// for Reed-Solomon encoding/decoding.
///
/// These algorithms are not properly documented in this library.
/// This is the trait you would implement to provide SIMD support
/// for a CPU architecture not already provided.
///
/// [`Naive`] engine is provided for those who want to
/// study the source code to understand [`Engine`].
Expand Down

0 comments on commit 95ddaf8

Please sign in to comment.