docs: Add module docs #114
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Was broken by #112
clippy was the reason I changed this in the first place... :rollseyes:
|
Documentation for this PR has been generated and is available at: https://n0-computer.github.io/iroh-blobs/pr/114/docs/iroh_blobs/ Last updated: 2025-07-11T15:01:47Z |
rklaehn
force-pushed
the
add-module-docs
branch
2 times, most recently
from
215b850 to
355a775
Compare
matheus23
approved these changes
Jul 11, 2025
Comment on lines
+72
to
+74
| fn deref(&self) -> &Self::Target { | ||
| &self.inner.store | ||
| } |
There was a problem hiding this comment.
Personally I'm not a huge fan of derefs, but also 🤷
There was a problem hiding this comment.
Personally I'm not a huge fan of derefs, but also 🤷
If we don't like derefs in public APIs, we would also have to remove the deref from MemStore and FsStore to the client API. But if we want to do this, it would have to be a separate PR since it would affect a lot of places.
Also add a missing Deref so you can use BlobsProtocol as a Store directly.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adds module docs and includes the README.md into the docs so the example in README.md is being tested.
Breaking Changes
None, I guess. The additional deref is not breaking.
Notes & open questions
There is an unrelated change, adding back lifetimes, the lack of which that make my local clippy unhappy (I only removed the lifetimes because of clippy in the first place).
Change checklist