Skip to content

Note annotated string API is experimental in Julia 1.11 in HISTORY.md #58134

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
Apr 29, 2025

Conversation

nhz2
Copy link
Contributor

@nhz2 nhz2 commented Apr 16, 2025

The annotated string API was marked as experimental in #55845

This PR updates HISTORY.md to reflect those changes.

The annotated string API was marked as experimental in JuliaLang#55845

This PR updates HISTORY.md based on those changes.
@nhz2 nhz2 added the docs This change adds or pertains to documentation label Apr 16, 2025
@Seelengrab
Copy link
Contributor

I think it would be better to have an explicit Experimental section rather than complete removal. Otherwise people are not going to know that experimental changes are even available for, well, experimenting.

Also, if this is official policy, should it also apply to other experimental things like --trim?

@nhz2
Copy link
Contributor Author

nhz2 commented Apr 16, 2025

Discourse may be a better place for announcing experimental changes. There isn't an official policy as far as I can tell.

@Seelengrab
Copy link
Contributor

If there is no official policy, why do these history items in particular need to be removed?

@nhz2
Copy link
Contributor Author

nhz2 commented Apr 16, 2025

A new Julia user reading these release notes could reasonably assume that this API is a new stable part of the language. They don't have to be removed, but this part of the release notes needs to be updated to avoid confusion.

@Seelengrab
Copy link
Contributor

That's right, hence my question whether this should apply to --trim too, since that is also considered experimental:

# NOTE: The interface and location of this script are considered unstable/experimental

It feels odd to me to single out one feature here, purging it from the HISTORY.md. I'm not aware of any case of this happening before.

@tecosaur
Copy link
Contributor

Maybe adding a note that this API has been relocated to the StyledStrings library itself might be a sensible modification?

@nhz2 nhz2 changed the title Remove annotated string API from HISTORY.md Note annotated string API is experimental in Julia 1.11 in HISTORY.md Apr 28, 2025
@nhz2
Copy link
Contributor Author

nhz2 commented Apr 28, 2025

Yes that makes sense, I moved the Annotated* type descriptions to the StyledStrings section and added a note that it is experimental.

@inkydragon inkydragon added the merge me PR is reviewed. Merge when all tests are passing label Apr 29, 2025
@IanButterworth IanButterworth merged commit d46b665 into JuliaLang:master Apr 29, 2025
9 checks passed
@IanButterworth
Copy link
Member

backport?

@nhz2 nhz2 deleted the patch-1 branch April 29, 2025 20:57
@nhz2 nhz2 added backport 1.11 Change should be backported to release-1.11 backport 1.12 Change should be backported to release-1.12 labels Apr 29, 2025
KristofferC pushed a commit that referenced this pull request May 5, 2025
@KristofferC KristofferC mentioned this pull request May 5, 2025
53 tasks
@giordano giordano removed the merge me PR is reviewed. Merge when all tests are passing label May 5, 2025
@KristofferC KristofferC removed the backport 1.12 Change should be backported to release-1.12 label May 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 1.11 Change should be backported to release-1.11 docs This change adds or pertains to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants