Add lib public API warning in readme

The public API can be improved and will change in future
tinted-theming · May 13, 2024 · 8e98050 · 8e98050
1 parent 1ad3521
commit 8e98050
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -12,6 +12,9 @@ There is both a Rust [Ribboncurls library] and [Ribboncurls CLI tool], depending
 on your needs. You can read more about those specific projects in their
 respective README.md files.
 
+**Note**: Ribboncurls library public API is subject to change, so use
+with caution.
+
 ## Code of Conduct
 
 This project and everyone participating in it is governed by the

diff --git a/ribboncurls/README.md b/ribboncurls/README.md
@@ -11,6 +11,9 @@ Ribboncurls is a Rust library for rendering [mustache] templates.
 It currently passes 132 of the 133 tests in the [mustache v1.4.1 spec]
 not including any optional modules.
 
+**Note**: Ribboncurls library public API is subject to change, so use
+with caution.
+
 ## Usage
 
 ### Basic Usage

diff --git a/ribboncurls/src/lib.rs b/ribboncurls/src/lib.rs
@@ -11,7 +11,7 @@ pub enum RcError {
     BadTag,
     #[error("missing end tag")]
     MissingEndTag,
-    #[error("blah")]
+    #[error("not matching")]
     NotMatching,
     #[error("bad input")]
     YamlParseError(#[from] serde_yaml::Error),