Skip to content

Allow deprecating variants #86

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

Merged
merged 3 commits into from
Jun 11, 2025
Merged

Conversation

MDLC01
Copy link
Collaborator

@MDLC01 MDLC01 commented Jun 10, 2025

This allows deprecating variants, which I did for the two variants that are already deprecated. I will start working on a corresponding typst/typst PR soon. I may wait until typst/typst#6159 is merged first.

With the current system, there is a weird edge case where modifierless variants can be deprecated independently of the symbol itself, although there is no syntactical way to deprecate a modifierless variant in out DSL. I don't think this is too much of an issue. It could even prove useful if we want to change the default variant of symbol (first, mark the modifierless variant as deprecated, then, in a future version, change its value and remove the deprecation), although this will require adding new syntax at this point.

@MDLC01 MDLC01 requested a review from laurmaedje June 10, 2025 19:13
@MDLC01 MDLC01 added meta Discussion about the structure of this repo breaking This involves a breaking change labels Jun 10, 2025
Copy link
Collaborator

@T0mstone T0mstone left a comment

Choose a reason for hiding this comment

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

Maybe we should generate the part that says something.something is deprecated automatically? That way could just write

@deprecated: use something.else instead

(This would also apply to symbol deprecations ofc)

@MDLC01
Copy link
Collaborator Author

MDLC01 commented Jun 10, 2025

Maybe we should generate the part that says something.something is deprecated automatically?

I thought about it, but I think it is easier to just do it manually. Especially if at some point we need a different message for whatever reason.

@laurmaedje laurmaedje merged commit a5428cb into typst:main Jun 11, 2025
1 check passed
@laurmaedje
Copy link
Member

typst/typst#6159 is also merged already, so no blockers on the Typst side. :)

@MDLC01
Copy link
Collaborator Author

MDLC01 commented Jun 11, 2025

Will get to it tonight

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking This involves a breaking change meta Discussion about the structure of this repo
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants