Skip to content

Make planck more useful (Proposal 26) #24

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 2 commits into from
Feb 25, 2025
Merged

Conversation

MDLC01
Copy link
Collaborator

@MDLC01 MDLC01 commented Jan 4, 2025

Description

This PR implements Proposal 26 (iteration 1) from the Symbol Proposals document. It changes planck to ħ (which gets italicized to ℏ in math thanks to typst/typst#5492), and removes the planck.reduce variant. For more context, see the discussion on Discord.

There is no way to take advantage of the symbol deprecation mechanism introduced in #19 to make this change smoother.

Breaking changes (cc. @laurmaedje)

planck.reduce becomes invalid, and planck changes codepoint.

@MDLC01 MDLC01 added the breaking This involves a breaking change label Jan 4, 2025
@T0mstone
Copy link
Collaborator

I don't like how this changes people's documents without warning.

I'm still a bit conflicted on whether that's just a necessary evil or whether we should look into adding some kind of ad-hoc warning in typst before making this change here...

@MDLC01
Copy link
Collaborator Author

MDLC01 commented Feb 22, 2025

I guess we could split this into multiple phases if we really want to make sure it does not break people's documents:

  • First, mark planck (but not planck.reduce) as deprecated (people should use a regular h instead).
  • In the next version, change planck to be the version with the bar, and deprecate planck.reduce (bare planck should be used instead).
  • Finally, in a third version, remove planck.reduce.

I'm not sure it would be worth spanning this over three versions, but if it breaks many documents, I think this is the only way to make a progressive change.

@T0mstone
Copy link
Collaborator

Hmm..... It may be a bit dumb, but that's probably the most robust way to go about it.

The more I think about it, the more I actually like the idea.

@laurmaedje would you say this is warranted or is it overkill?
I can also accept the viewpoint that doing this change in one go is just something users will have to deal with (tho I don't really like it).

@laurmaedje
Copy link
Member

Very similar to what I proposed here for read: typst/typst#5672

For read, it's a bit more critical than for planck, but I could imagine going about it that way here as well.

@MDLC01
Copy link
Collaborator Author

MDLC01 commented Feb 23, 2025

All this would have to be done on Typst's side, tough. Codex does not have the ability to express such precise warnings.

@T0mstone
Copy link
Collaborator

After another brief discussion of this on discord, I'll drop my concern for this, so LGTM.

@MDLC01 MDLC01 merged commit c57c817 into typst:main Feb 25, 2025
1 check passed
@MDLC01 MDLC01 deleted the proposal-26 branch February 25, 2025 20:55
@MDLC01
Copy link
Collaborator Author

MDLC01 commented Feb 25, 2025

To be clear, what the next Typst changelog should mention is that planck.reduce was renamed to simply planck, and previous uses of planck can be replaced with simply h in math mode.

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants