Skip to content

Commit

Permalink
Mark API as Experimental
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
KristofferC authored and tecosaur committed Sep 19, 2024
1 parent cfcfe8c commit 8332e45
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/src/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# [StyledStrings](@id stdlib-styledstrings)

!!! note
The API for StyledStrings and AnnotatedStrings is considered experimental and is subject to change between
Julia versions.

## [Styling](@id stdlib-styledstrings-styling)

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

0 comments on commit 8332e45

Please sign in to comment.