docs: pass Doc
instead of Iroh
in example
#2432
Merged
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
Since
iroh/examples/client.rs
is the first example users see, it's likely they will use this file as a starting point for their app skeleton. I find it easier to keepDoc
in a struct and pass it around rather than usingiroh::client::Iroh
.I've also added a comment about the
content_bytes()
method, noting its ability to accept either aDoc
orclient::Iroh
.Related:
iroh/iroh-cli/src/commands/doc.rs
Line 689 in 17c654e
iroh/iroh/tests/sync.rs
Line 1024 in 17c654e
Breaking Changes
No.
Notes & open questions
Change checklist