From 8332e457e11fc3feb81ff9d8a1eaf6a500e57124 Mon Sep 17 00:00:00 2001 From: KristofferC Date: Thu, 19 Sep 2024 14:39:06 +0200 Subject: [PATCH] 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. --- docs/src/index.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/src/index.md b/docs/src/index.md index 7f91616..99d7bb8 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -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