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

ravif: Add #[deprecated] notice to ColorSpace #91

Merged
merged 1 commit into from
Dec 12, 2024

Conversation

MarijnS95
Copy link
Contributor

Commit e03108a ("Rename color space → model") (for #88) added/kept hidden variants of ColorSpace and with_internal_color_space() for backwards compatibility, to not need a semver-breaking release. Unfortunately these were not annotated with #[deprecated], making users unaware of this change until they would (if ever) upgrade to the next breaking release of ravif where such helpers are supposedly going to be removed again.

Tell users about this with a #[deprecated] notice to guide them to the new item names.

Commit e03108a ("Rename color space → model") (for kornelski#88) added/kept
hidden variants of `ColorSpace` and `with_internal_color_space()`
for backwards compatibility, to not need a semver-breaking release.
Unfortunately these were not annotated with `#[deprecated]`, making
users unaware of this change until they would (if ever) upgrade to the
next breaking release of `ravif` where such helpers are supposedly going
to be removed again.

Tell users about this with a `#[deprecated]` notice to guide them to the
new item names.
@kornelski kornelski merged commit 2f1ed87 into kornelski:main Dec 12, 2024
@kornelski
Copy link
Owner

It's a cosmetic change, so I didn't want bother users about it.

@MarijnS95 MarijnS95 deleted the deprecated branch December 12, 2024 21:38
@MarijnS95
Copy link
Contributor Author

I'd argue it's useful to point them in the right direction, not purely cosmetic.

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