Clippy fixes #43

chris-ha458 · 2023-09-19T12:41:09Z

This PR ensures that even cargo clippy -- -Wclippy::pedantic yields no warnings.

One issue : I'm not sure if k_most_common_ordered can actually panic?
It seems like logically heap won't be empty.
If it can, maybe documentation could be better so it is understood in relation to outputs.
If not, maybe we can change it to unwrap and either document that it doesn't panic or suppress the lint

I'm not sure if this can actually panic?

coriolinus · 2023-09-19T13:07:48Z

src/impls/create.rs

@@ -38,7 +38,7 @@ where
 {
    fn default() -> Self {
        Self {
-            map: Default::default(),
+            map: HashMap::default(),
            zero: Default::default(),


Why specify HashMap::default but not N::default?

The honest answer is that because only hashmap triggered the clippy.
I think the current lint only looks for std or core traits.

Taking a closer look into the lint, it would be idiomatic to also change zero to N:: default.
added a commit for that.

coriolinus · 2023-09-19T13:09:37Z

src/lib.rs

@@ -499,6 +498,9 @@ where
    /// be worth experimenting to see which of the two methods is faster.
    ///
    /// [`most_common_ordered`]: Counter::most_common_ordered
+    /// 
+    /// # Panics
+    /// Panics if heap is empty
    pub fn k_most_common_ordered(&self, k: usize) -> Vec<(T, N)> {


This cannot in fact panic, because the heap is never empty. There are early returns in the function for if k == 0 or if k >= self.map.len().

changed docs to reflect that it does not in fact panic as implemented

coriolinus · 2023-09-19T13:12:33Z

Changing an expect to an unwrap is a bad idea: if somehow the precondition does ever fail, we'll get better documentation of what we expected to hold true.

reflects the fact that, despite the use of expect, current code does not panic

coriolinus · 2023-09-19T13:54:44Z

src/lib.rs

+    /// # Panics
+    /// Preconditions ensure that the current implementation does not panic. 


Is the clippy logic looking for the existence of a "Panics" section in the docs if there is a .expect in the function? I'd prefer to simply suppress that lint. Adding a big, bold-face documentation item "Panics: the current implementation does not panic" is unhelpful and pointless.

I suppressed the lint with a comment that reflects how it doesnt panic currently.

That suppresses the lint right now, but it introduces distracting and potentially confusing documentation. The default expectation of a function is that it does not panic, unless it has a "Panics" section in the documentation. Adding a "Panics" section which just says "this does not panic" does not help someone reading the documentation, but it has the potential to confuse them. Better to omit that section of the documentation and instead suppress the lint with an #[allow(clippy::wants_pointless_documentation)] (not the actual lint name) annotation.

oops sorry i was referring to eca86c5 I forgot to actually push before commenting.

i can also remove the insource documentation as well if you feel it is spurious

coriolinus

This is good, thanks!

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [counter](https://togithub.com/coriolinus/counter-rs) | dependencies | minor | `0.5.7` -> `0.6.0` | --- ### Release Notes <details> <summary>coriolinus/counter-rs (counter)</summary> ### [`v0.6.0`](https://togithub.com/coriolinus/counter-rs/releases/tag/v0.6.0) [Compare Source](https://togithub.com/coriolinus/counter-rs/compare/v0.5.7...v0.6.0) #### What's Changed - update edition, add `counter` keyword by [@chris-ha458](https://togithub.com/chris-ha458) in [https://github.com/coriolinus/counter-rs/pull/34](https://togithub.com/coriolinus/counter-rs/pull/34) - refactor tests and impls into distinct modules by [@chris-ha458](https://togithub.com/chris-ha458) in [https://github.com/coriolinus/counter-rs/pull/36](https://togithub.com/coriolinus/counter-rs/pull/36) - small doc formatting by [@chris-ha458](https://togithub.com/chris-ha458) in [https://github.com/coriolinus/counter-rs/pull/38](https://togithub.com/coriolinus/counter-rs/pull/38) - deprecate `init` method by [@coriolinus](https://togithub.com/coriolinus) in [https://github.com/coriolinus/counter-rs/pull/41](https://togithub.com/coriolinus/counter-rs/pull/41) - do not use deprecated `init` method by [@coriolinus](https://togithub.com/coriolinus) in [https://github.com/coriolinus/counter-rs/pull/42](https://togithub.com/coriolinus/counter-rs/pull/42) - With capacity by [@chris-ha458](https://togithub.com/chris-ha458) in [https://github.com/coriolinus/counter-rs/pull/40](https://togithub.com/coriolinus/counter-rs/pull/40) - Clippy fixes by [@chris-ha458](https://togithub.com/chris-ha458) in [https://github.com/coriolinus/counter-rs/pull/43](https://togithub.com/coriolinus/counter-rs/pull/43) - Implement Serialize and Deserialize by [@matthewmcintire-savantx](https://togithub.com/matthewmcintire-savantx) in [https://github.com/coriolinus/counter-rs/pull/46](https://togithub.com/coriolinus/counter-rs/pull/46) #### New Contributors - [@chris-ha458](https://togithub.com/chris-ha458) made their first contribution in [https://github.com/coriolinus/counter-rs/pull/34](https://togithub.com/coriolinus/counter-rs/pull/34) - [@matthewmcintire-savantx](https://togithub.com/matthewmcintire-savantx) made their first contribution in [https://github.com/coriolinus/counter-rs/pull/46](https://togithub.com/coriolinus/counter-rs/pull/46) **Full Changelog**: coriolinus/counter-rs@v0.5.7...v0.5.8 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/ruancomelli/learning-rust).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

chris-ha458 added 3 commits September 19, 2023 21:30

allow must_use_candidate crate_wide

b024179

fix default_trait_access

d30b6ba

missing_panics_docs

354b5f9

I'm not sure if this can actually panic?

coriolinus reviewed Sep 19, 2023

View reviewed changes

chris-ha458 added 2 commits September 19, 2023 22:47

Update create.rs

93f6fba

amend panic docs

1ab1d58

reflects the fact that, despite the use of expect, current code does not panic

coriolinus reviewed Sep 19, 2023

View reviewed changes

remove pointless # panics section

eca86c5

coriolinus approved these changes Sep 19, 2023

View reviewed changes

coriolinus merged commit 1d41465 into coriolinus:master Sep 19, 2023
1 check passed

chris-ha458 deleted the clippy_fixes branch September 19, 2023 15:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Clippy fixes #43

Clippy fixes #43

chris-ha458 commented Sep 19, 2023

coriolinus Sep 19, 2023

chris-ha458 Sep 19, 2023

coriolinus Sep 19, 2023

chris-ha458 Sep 19, 2023

coriolinus commented Sep 19, 2023

coriolinus Sep 19, 2023

chris-ha458 Sep 19, 2023

coriolinus Sep 19, 2023

chris-ha458 Sep 19, 2023

coriolinus left a comment

		/// # Panics
		/// Preconditions ensure that the current implementation does not panic.

Clippy fixes #43

Clippy fixes #43

Conversation

chris-ha458 commented Sep 19, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

coriolinus commented Sep 19, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

coriolinus left a comment

Choose a reason for hiding this comment