Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(prestate): comment prestate more clear #1527

Merged
merged 3 commits into from
Oct 19, 2024

Conversation

jsvisa
Copy link
Contributor

@jsvisa jsvisa commented Oct 19, 2024

Motivation

  1. fix an clippy warning:
warning: first doc comment paragraph is too long
  --> crates/provider/src/layers/cache.rs:61:1
   |
61 | / /// The [`CacheProvider`] holds the underlying in-memory LRU cache and overrides methods from the
62 | | /// [`Provider`] trait that should attempt to fetch from cache and fallback to the RPC in case of a
63 | | /// cache miss.
64 | | ///
65 | | /// Most importantly, the [`CacheProvider`] adds `save_cache` and `load_cache` methods to the
   | |_
   |
   = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#too_long_first_doc_paragraph
   = note: `-W clippy::too-long-first-doc-paragraph` implied by `-W clippy::all`
   = help: to override `-W clippy::all` add `#[allow(clippy::too_long_first_doc_paragraph)]`

warning: `alloy-provider` (lib) generated 1 warning
  1. make the prestate comments more clear

Solution

PR Checklist

  • Added Tests
  • Added Documentation
  • Breaking changes

Signed-off-by: jsvisa <delweng@gmail.com>
Signed-off-by: jsvisa <delweng@gmail.com>
@DaniPopes DaniPopes merged commit a1a191c into alloy-rs:main Oct 19, 2024
26 checks passed
@jsvisa jsvisa deleted the prestate-comment branch October 19, 2024 08:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants