Skip to content

Rename circle modifier for symbols that are circled to "o" #62

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

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

Enivex
Copy link
Collaborator

@Enivex Enivex commented May 17, 2025

This is in conflict with #34 . However, circled symbols are extremely common, both in terms of the number of characters (we're still missing a bunch of symbols) and in usage. Therefore, I believe that it deserves its own short and cute modifier, which also has the benefit of resolving the ambiguous conflicting uses of "circle". There is also precedence, in the form of "oo" to mean infinity.

Notes:

  • ast.circle was really a circled variant of ast.op, so I used ast.op.o.
  • circle.nested was really a circled variant of circle.stroked.tiny, so I used circle.stroked.tiny.o
  • The aliases compose.o and convolve.o were missing. I added them

I initially wanted to add additional symbols in this PR, but in the process of looking into this I discovered a number of issues that should ideally be resolved first. I therefore prioritized just getting the ball rolling.

@MDLC01
Copy link
Collaborator

MDLC01 commented May 18, 2025

If circle.stroked.tiny.o is the same as compose.o, maybe we can only keep compose.o. I feel like the .o modifier is less clear in meaning when it comes to geometrical shapes, compared to mathematical operators.

@Enivex
Copy link
Collaborator Author

Enivex commented May 18, 2025

If circle.stroked.tiny.o is the same as compose.o, maybe we can only keep compose.o. I feel like the .o modifier is less clear in meaning when it comes to geometrical shapes, compared to mathematical operators.

I'd be okay with that

@MDLC01 MDLC01 added the breaking This involves a breaking change label May 20, 2025
@MDLC01 MDLC01 requested a review from laurmaedje May 20, 2025 16:38
@Enivex Enivex mentioned this pull request Jun 9, 2025
@Enivex
Copy link
Collaborator Author

Enivex commented Jun 9, 2025

I did not add a deprecation to slash.circle, since it will likely never see release.

@Enivex Enivex requested review from T0mstone and mkorje June 9, 2025 22:34
@T0mstone
Copy link
Collaborator

If circle.stroked.tiny.o is the same as compose.o, maybe we can only keep compose.o. I feel like the .o modifier is less clear in meaning when it comes to geometrical shapes, compared to mathematical operators.

I'm a bit bugged by the inconsistency of having compose have a unique variant instead of being a strict alias. Can't we keep circle.nested somehow? Or maybe go the other way and deprecate circle.stroked.tiny, given that its purpose in Unicode is strictly as a mathematical operator?

@Enivex
Copy link
Collaborator Author

Enivex commented Jun 10, 2025

I'd rather go the second route. There's a number of symbols that are currently named with little regard for what they are actually used for.

That being said, I'm not sure if that change should be made in this PR or not.

Copy link
Collaborator

@mkorje mkorje left a comment

Choose a reason for hiding this comment

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

That being said, I'm not sure if that change should be made in this PR or not.

I think it'd be better to do in another PR then, where we could review other symbols' names.

@MDLC01
Copy link
Collaborator

MDLC01 commented Jun 10, 2025

Yes there is definitely some work to do around geometrical shapes, in the same vein as #28.

@T0mstone T0mstone mentioned this pull request Jun 10, 2025
@MDLC01
Copy link
Collaborator

MDLC01 commented Jun 11, 2025

With #86 merged, this can now use the dedicated deprecation syntax for variants.

@Enivex
Copy link
Collaborator Author

Enivex commented Jun 12, 2025

With #86 merged, this can now use the dedicated deprecation syntax for variants.

Done. I also readded circle .stroked.tiny.o as deprecated

@Enivex
Copy link
Collaborator Author

Enivex commented Jun 12, 2025

What do people feel about renaming dash.o to minus.o.alt while we're already deprecating dash.circled? Despite the official unicode name, which I think comes from the fact that the horizontal bar has approximately en-dash length, it's a binary operator and seemingly used for the same things as minus.o. It doesn't feel at home among the punctuation.

It would also aid discoverability.

@T0mstone
Copy link
Collaborator

I also readded circle .stroked.tiny.o as deprecated

It never existed in the firstplace, I don't think there's a point to adding it now when it'd be deprecated anyway.

@Enivex
Copy link
Collaborator Author

Enivex commented Jun 12, 2025

I also readded circle .stroked.tiny.o as deprecated

It never existed in the firstplace, I don't think there's a point to adding it now when it'd be deprecated anyway.

Oops, brain fart

@Enivex Enivex added the waiting on reviews Breaking and non-breaking changes need respectively 3 and 2 reviews label Jun 13, 2025
@Enivex Enivex linked an issue Jun 13, 2025 that may be closed by this pull request
@Enivex Enivex mentioned this pull request Jun 14, 2025
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 waiting on reviews Breaking and non-breaking changes need respectively 3 and 2 reviews
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Use circled instead of circle
4 participants