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.

Sign up for GitHub

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

Jump to bottom

rename and deprecate the multicodec package #259

Open
mvdan opened this issue Sep 27, 2021 · 3 comments
Open

rename and deprecate the multicodec package #259

mvdan opened this issue Sep 27, 2021 · 3 comments
Assignees
@rvagg
Labels
effort/hours Estimated to take one or several hours exp/intermediate Prior experience is likely helpful good first issue Good issue for new contributors pending/changewindow The issue is well-defined, but action is pending until we enter a period of accepting changes.

Comments

@mvdan
Copy link
Contributor

mvdan commented Sep 27, 2021

To avoid confusing conflict with https://github.com/multiformats/go-multicodec, which came first, and really can't have another name than "multicodec". Whereas the multicodec package is a registry, so we can call it multiregistry or codecregistry.
@mvdan mvdan self-assigned this Sep 27, 2021
@warpfork warpfork added effort/hours Estimated to take one or several hours exp/intermediate Prior experience is likely helpful pending/changewindow The issue is well-defined, but action is pending until we enter a period of accepting changes. labels Nov 9, 2021
@mvdan mvdan removed their assignment Mar 4, 2022
@mvdan mvdan added the good first issue Good issue for new contributors label Mar 4, 2022
@mvdan
Copy link
Contributor Author

mvdan commented Mar 4, 2022

One more detail: we shouldn't simply move the package, as that would break downstreams immediately. We can move the package and add a "forwarding" package in the old location, forwarding the APIs, and being marked as deprecated in favor of the new one.

@rvagg rvagg self-assigned this Aug 2, 2022
rvagg added a commit that referenced this issue Sep 7, 2022
@rvagg
feat: rename multicodec pkg to codecregistry, leaving redirect
1ef4d25 
Fixes: #259

I'm not sure this is possible since `DefaultRegistry` is not a pointer, so we
can't simply provide a redirect for it without breaking code that uses it. I've
left the dependent code intact here for now to demonstrate breakage.
rvagg added a commit that referenced this issue Sep 7, 2022
@rvagg
feat: rename multicodec pkg to codecregistry, leaving redirect
d6f40e6 
Fixes: #259

I'm not sure this is possible since `DefaultRegistry` is not a pointer, so we
can't simply provide a redirect for it without breaking code that uses it. I've
left the dependent code intact here for now to demonstrate breakage.
@rvagg rvagg mentioned this issue Sep 7, 2022
Closed
@rvagg
Copy link
Member

rvagg commented Nov 30, 2022

turns out to be too disruptive; I'm going to say this isn't worth it, see also #467

@rvagg rvagg closed this as completed Nov 30, 2022
@rvagg
Copy link
Member

rvagg commented Dec 8, 2022

Reopened based on feedback @ #467 (comment) but putting this in the backlog as it's hard to justify as a priority with limited bandwidth at this stage.

@rvagg rvagg reopened this Dec 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@rvagg rvagg

Labels
effort/hours Estimated to take one or several hours exp/intermediate Prior experience is likely helpful good first issue Good issue for new contributors pending/changewindow The issue is well-defined, but action is pending until we enter a period of accepting changes.
Projects
IPLD team's weekly tracker
Status: 🗄️ Backlog
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: rename multicodec pkg to codecregistry, leaving redirect ipld/go-ipld-prime
3 participants
@rvagg @warpfork @mvdan