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

example(iroh): Improve and document custom-protocol example #2468

Merged
merged 4 commits into from
Jul 8, 2024

Conversation

Frando
Copy link
Member

@Frando Frando commented Jul 5, 2024

Description

  • Changes the custom-protocol example to do something a bit more akin to something useful while still being concise
  • Add a lot of comments everywhere to really explain what's going on

Breaking Changes

Notes & open questions

Change checklist

  • Self-review.
  • Documentation updates following the style guide, if relevant.

@Frando Frando changed the base branch from main to fix-staging July 5, 2024 15:11
@Frando Frando marked this pull request as ready for review July 5, 2024 15:11
@Frando Frando force-pushed the example-custom-proto branch from cae3c6f to 0d8b44a Compare July 5, 2024 15:13
Base automatically changed from fix-staging to main July 5, 2024 15:27
@Frando Frando force-pushed the example-custom-proto branch from 0d8b44a to f98a416 Compare July 5, 2024 15:34
/// Query the local database.
///
/// Returns the list of hashes of blobs which contain `query` literally.
pub async fn query_local(&self, query: &str) -> Result<Vec<Hash>> {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
pub async fn query_local(&self, query: &str) -> Result<Vec<Hash>> {
pub fn query_local(&self, query: &str) -> Vec<Hash> {

Needed to do this to fix some type error.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

uh yea thanks, this was a refactor leftover

Copy link
Contributor

@matheus23 matheus23 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I trust you to fix the type error.
Other than that I think this is great :)
🎉

@Frando Frando force-pushed the example-custom-proto branch from f7a8dac to 9a66926 Compare July 8, 2024 09:28
@Frando Frando enabled auto-merge July 8, 2024 09:29
@Frando Frando added this pull request to the merge queue Jul 8, 2024
Merged via the queue into main with commit 203f9e7 Jul 8, 2024
25 checks passed
@dignifiedquire dignifiedquire deleted the example-custom-proto branch July 8, 2024 10:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants