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

readme: introduce a migration guide. #288

Merged
merged 1 commit into from
Nov 10, 2021
Merged

readme: introduce a migration guide. #288

merged 1 commit into from
Nov 10, 2021

Conversation

warpfork
Copy link
Collaborator

@warpfork warpfork commented Nov 8, 2021

This document discusses interfaces, APIs, and concept names from other libraries in golang, and how they map to this library.

Some references are to storage systems which are appearing in #279 .

we don't use APIs that force that style of future-aggregation anymore, because it's bad for pipelining.
Just use `Store` and `Load`.
- Were you using [ipfs/go-ipld-format.Node](https://pkg.go.dev/github.com/ipfs/go-ipld-format#Node)?
- That's actually a semantic doozy -- we use the word "node" _much_ differently now.
Copy link
Member

Choose a reason for hiding this comment

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

whoa boy, yeah, is it any wonder this continues to confuse people if we have multiple uses of the word that mean something entirely different but so closely?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yeah, I wish... this was different, somehow. But most of those wishes seem to involve time machines at this point. Alas.

Copy link
Member

@rvagg rvagg left a comment

Choose a reason for hiding this comment

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

👍 good start
there's probably a slew of stuff in go-merkledag worth mentioning too, including the dag-pb stuff (already here) and even DAG "walking" which should be replaced with selectors now

@warpfork
Copy link
Collaborator Author

Okay, I'm in cleanup mode today, so I'm gonna merge this. Agree more pointers on migrating code about walking would probably be good in the future too though.

@warpfork warpfork merged commit 027c256 into master Nov 10, 2021
@warpfork warpfork deleted the migration-guide branch November 10, 2021 18:04
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