Make it possible to deprecate symbols and modules #19
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MDLC01
added
meta
|
Given this is a change to the public interface, cc. @laurmaedje. |
MDLC01
added a commit
to MDLC01/typst
that referenced
this pull request
Dec 28, 2024
T0mstone
added a commit
to T0mstone/codex
that referenced
this pull request
Jan 20, 2025
This avoids it visually colliding with the deprecation annotation from typst#19.
laurmaedje
approved these changes
Feb 3, 2025
|
I renamed Thank you! |
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds the ability to deprecate definitions (i.e., symbols and modules), as suggested in #2 (comment).
Syntax-wise, marking a definition as deprecated can be done by adding
@deprecated: deprecation messageto the line preceding the definition.Currently, this feature is not used, but it could be used to mark
sym.interas deprecated in #17.1Deprecated definitions have an associated message. For now, Typst does not support deprecating constants, but this is implemented in typst/typst#5582.
Footnotes
Proposal 14 (partially implemented in Add
interas an alternative forsect(Proposal 14, part I) #17) also removes thesym.integral.sectvariant, which, as a variant, cannot be deprecated with this PR. This is probably fine in this specific case, becausesym.integral.sectis not a highly used symbol, but we may want the ability to deprecate specific variants in the future. ↩