Skip to content

Commit 8332e45

Browse files
KristofferCtecosaur
authored andcommitted
Mark API as Experimental
Given the ongoing discussion about how exactly bits of this library should work (namely the Faces system), it's worth declaring that the API is experimental, so it can stabilize while also being used across the stdlib. The mention of AnnotatedStrings is slightly premature, but we're about to bring that in as part of what StyledStrings claims API responsibility for. This is in many ways the main motivation for this notice.
1 parent cfcfe8c commit 8332e45

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

docs/src/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# [StyledStrings](@id stdlib-styledstrings)
22

3+
!!! note
4+
The API for StyledStrings and AnnotatedStrings is considered experimental and is subject to change between
5+
Julia versions.
6+
37
## [Styling](@id stdlib-styledstrings-styling)
48

59
When working with strings, formatting and styling often appear as a secondary

0 commit comments

Comments
 (0)