Skip to content

feat!: rename some features to be more conventional and fix the way t… #436

feat!: rename some features to be more conventional and fix the way t…

feat!: rename some features to be more conventional and fix the way t… #436

Triggered via push October 1, 2024 20:58
Status Success
Total duration 4m 14s
Artifacts

coverage.yml

on: push
Test Coverage
4m 4s
Test Coverage
Fit to window
Zoom out
Zoom in

Annotations

14 errors
first doc comment paragraph is too long: src/nearest_neighbour.rs#L5
error: first doc comment paragraph is too long --> src/nearest_neighbour.rs:5:1 | 5 | / /// Represents an entry in the results of a nearest neighbour query, with `distance` being the distance of this 6 | | /// particular item from the query point, and `item` being the stored item index that was found 7 | | /// as part of the query. | |_ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#too_long_first_doc_paragraph
empty line after doc comment: src/immutable/float/kdtree.rs#L588
error: empty line after doc comment --> src/immutable/float/kdtree.rs:588:5 | 588 | / /// 589 | | | |_ ... 599 | pub fn iter(&self) -> impl Iterator<Item = (T, [A; K])> + '_ { | ------------------------------------------------------------ the comment documents this method | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#empty_line_after_doc_comments = help: if the empty line is unintentional remove it help: if the documentation should include the empty line include it in the comment | 589 | /// |
manually reimplementing `is_power_of_two`: src/immutable/float/kdtree.rs#L242
error: manually reimplementing `is_power_of_two` --> src/immutable/float/kdtree.rs:242:16 | 242 | if i.count_ones() == 1 { | ^^^^^^^^^^^^^^^^^^^ help: consider using `.is_power_of_two()`: `i.is_power_of_two()` | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#manual_is_power_of_two = note: `-D clippy::manual-is-power-of-two` implied by `-D warnings` = help: to override `-D warnings` add `#[allow(clippy::manual_is_power_of_two)]`
first doc comment paragraph is too long: src/immutable/float/kdtree.rs#L1
error: first doc comment paragraph is too long --> src/immutable/float/kdtree.rs:1:1 | 1 | / //! Immutable Floating point k-d tree. Offers less memory utilisation, smaller size 2 | | //! when serialized, and faster more consistent query performance. This comes at the 3 | | //! expense of not being able to modify the contents of the tree after its initial 4 | | //! construction, and longer construction times - perhaps prohibitively so. 5 | | //! As with the vanilla tree, [`f64`] or [`f32`] are supported currently for co-ordinate 6 | | //! values, or [`f16`](https://docs.rs/half/latest/half/struct.f16.html) if the `f16` feature is enabled | |_ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#too_long_first_doc_paragraph
empty line after doc comment: src/float/kdtree.rs#L199
error: empty line after doc comment --> src/float/kdtree.rs:199:5 | 199 | / /// 200 | | | |_ ... 214 | pub fn iter(&self) -> impl Iterator<Item = (T, [A; K])> + '_ { | ------------------------------------------------------------ the comment documents this method | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#empty_line_after_doc_comments = help: if the empty line is unintentional remove it help: if the documentation should include the empty line include it in the comment | 200 | /// |
first doc comment paragraph is too long: src/float/kdtree.rs#L18
error: first doc comment paragraph is too long --> src/float/kdtree.rs:18:1 | 18 | / /// Axis trait represents the traits that must be implemented 19 | | /// by the type that is used as the first generic parameter, `A`, 20 | | /// on the float [`KdTree`]. This will be [`f64`] or [`f32`], 21 | | /// or [`f16`](https://docs.rs/half/latest/half/struct.f16.html) if the `f16` feature is enabled | |_ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#too_long_first_doc_paragraph
first doc comment paragraph is too long: src/float/kdtree.rs#L1
error: first doc comment paragraph is too long --> src/float/kdtree.rs:1:1 | 1 | / //! Floating point k-d tree, for use when the co-ordinates of the points being stored in the tree 2 | | //! are floats. f64 or f32 are supported currently, or [`f16`](https://docs.rs/half/latest/half/struct.f16.html) 3 | | //! if the `f16` feature is enabled | |_ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#too_long_first_doc_paragraph
first doc comment paragraph is too long: src/float/mod.rs#L1
error: first doc comment paragraph is too long --> src/float/mod.rs:1:1 | 1 | / //! Floating point k-d tree, for use when the co-ordinates of the points being stored in the tree 2 | | //! are floats. [`f64`] or [`f32`] are the types that are supported for use as co-ordinates, 3 | | //! or [`f16`](https://docs.rs/half/latest/half/struct.f16.html) if the `f16` feature is enabled | |_ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#too_long_first_doc_paragraph
empty line after doc comment: src/fixed/kdtree.rs#L263
error: empty line after doc comment --> src/fixed/kdtree.rs:263:5 | 263 | / /// 264 | | | |_ ... 280 | pub fn iter(&self) -> impl Iterator<Item = (T, [A; K])> + '_ { | ------------------------------------------------------------ the comment documents this method | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#empty_line_after_doc_comments = note: `-D clippy::empty-line-after-doc-comments` implied by `-D warnings` = help: to override `-D warnings` add `#[allow(clippy::empty_line_after_doc_comments)]` = help: if the empty line is unintentional remove it help: if the documentation should include the empty line include it in the comment | 264 | /// |
first doc comment paragraph is too long: src/fixed/kdtree.rs#L21
error: first doc comment paragraph is too long --> src/fixed/kdtree.rs:21:1 | 21 | / /// Axis trait represents the traits that must be implemented 22 | | /// by the type that is used as the first generic parameter, `A`, 23 | | /// on [`FixedKdTree`](crate::fixed::kdtree::KdTree). A type from the [`Fixed`](https://docs.rs/fixed/1.21.0/fixed) crate will implement 24 | | /// all of the traits required by Axis. For example [`FixedU16<U14>`](https://docs.rs/fixed/1.21.0/fixed/struct.FixedU16.html). | |_ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#too_long_first_doc_paragraph
first doc comment paragraph is too long: src/fixed/kdtree.rs#L1
error: first doc comment paragraph is too long --> src/fixed/kdtree.rs:1:1 | 1 | / //! Fixed point k-d tree, for use when the co-ordinates of the points being stored in the tree 2 | | //! are fixed point or integers. [`u8`], [`u16`], [`u32`], and [`u64`] based fixed-point / integers are supported 3 | | //! via the [`Fixed`](https://docs.rs/fixed/1.21.0/fixed) crate, eg [`FixedU16<U14>`](https://docs.rs/fixed/1.21.0/fixed/struct.FixedU16.... 4 | | //! decimal point. | |_ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#too_long_first_doc_paragraph
first doc comment paragraph is too long: src/fixed/distance.rs#L11
error: first doc comment paragraph is too long --> src/fixed/distance.rs:11:1 | 11 | / /// Returns the squared euclidean distance between two points. When you only 12 | | /// need to compare distances, rather than having the exact distance between 13 | | /// the points, this metric is beneficial because it avoids the expensive square 14 | | /// root computation. 15 | | /// 16 | | /// # Examples | |_ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#too_long_first_doc_paragraph
first doc comment paragraph is too long: src/fixed/mod.rs#L1
error: first doc comment paragraph is too long --> src/fixed/mod.rs:1:1 | 1 | / //! Fixed point k-d tree, for use when the co-ordinates of the points being stored in the tree 2 | | //! are fixed point or integers. [`u8`], [`u16`], [`u32`], and [`u64`] based fixed-point / integers are supported 3 | | //! via the Fixed crate, eg [`FixedU16<U14>`](fixed::FixedU16<U14>) for a 16-bit fixed point number with 14 bits after the 4 | | //! decimal point. | |_ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#too_long_first_doc_paragraph
first doc comment paragraph is too long: src/best_neighbour.rs#L5
error: first doc comment paragraph is too long --> src/best_neighbour.rs:5:1 | 5 | / /// Represents an entry in the results of a "best" query, with `distance` being the distance of this 6 | | /// particular item from the query point, and `item` being the stored item index that was found 7 | | /// as part of the query. | |_ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#too_long_first_doc_paragraph = note: `-D clippy::too-long-first-doc-paragraph` implied by `-D warnings` = help: to override `-D warnings` add `#[allow(clippy::too_long_first_doc_paragraph)]`