Skip to content

Add deprecated LayoutVerified type alias #221

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

Closed
joshlf opened this issue Aug 3, 2023 · 0 comments
Closed

Add deprecated LayoutVerified type alias #221

joshlf opened this issue Aug 3, 2023 · 0 comments

Comments

@joshlf
Copy link
Member

joshlf commented Aug 3, 2023

Since we renamed LayoutVerified to Ref in #203, we should add a type alias to help ease the transition to 0.7.0. This alias should be marked as #[deprecated] to nudge users in the right direction.

It's also possible that we could use this approach (albeit without the #[deprecated] annotation) to backport the rename to 0.6.x (see #215). Without the deprecation warning, it's unlikely that many people would switch to Ref - the main benefit would be to make future cherry-picks less likely to result in conflights (#203 was a large change that affected many lines of code). We would need to be very careful to ensure that the type alias is genuinely a backwards-compatible standin for the struct itself.

joshlf added a commit that referenced this issue Aug 3, 2023
This should help make the transition to 0.7.0 easier, as code which
currently uses `LayoutVerified` will get a deprecation warning instead
of a (much less helpful) "not found" error.

Closes #221
@joshlf joshlf closed this as completed in 8effca5 Aug 8, 2023
@joshlf joshlf mentioned this issue Aug 20, 2023
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

No branches or pull requests

1 participant