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

Rename LayerSet to LayerContents & clarify ordering #329

Merged
merged 1 commit into from
Oct 16, 2023

Conversation

RickyDaMa
Copy link
Collaborator

Will close #326

Documentation also now explicitly states the layers are ordered


If we were interested in maintaining backwards compatibility, we could do a re-export under the old name:

#[deprecated(
    note = "old naming convention, switch to LayerContents instead",
    since = "0.12.2",
)]
pub use LayerContents as LayerSet;

Clarify ordering in documentation
@RickyDaMa RickyDaMa requested a review from cmyr October 13, 2023 13:48
@cmyr
Copy link
Member

cmyr commented Oct 13, 2023

I'm happy either way, I'm not sure we have enough outside users to be too concerned about the breakage, but if you're feeling extra kind you should feel free, in which case I'd probably simplify the deprecation message to just "renamed to LayerContents" (but anything is fine really)

Copy link
Member

@cmyr cmyr left a comment

Choose a reason for hiding this comment

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

Happy with or without the deprecation warning :)

@RickyDaMa
Copy link
Collaborator Author

Let's save ourselves the hassle of removing it later then 😄

@RickyDaMa RickyDaMa merged commit 00f83cd into master Oct 16, 2023
4 checks passed
@RickyDaMa RickyDaMa deleted the layer-contents branch October 16, 2023 09:34
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.

LayerSet is ordered when it is not implied or documented as such
2 participants