From 976c136ab6897809ba94bd1ada1a8cd831236cfa Mon Sep 17 00:00:00 2001 From: Daniel Mensinger Date: Sun, 3 Mar 2019 11:13:11 +0100 Subject: [PATCH] rewriter: Mark the CLI as experimental --- docs/markdown/Rewriter.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/markdown/Rewriter.md b/docs/markdown/Rewriter.md index f143ac066..73611e951 100644 --- a/docs/markdown/Rewriter.md +++ b/docs/markdown/Rewriter.md @@ -24,6 +24,12 @@ normal CLI is mostly designed for everyday use. The "script mode", on the other hand, is meant to be used by external programs (IDEs, graphical frontends, etc.) +The rewriter itself is considered stable, however the user interface and the +"script mode" API might change in the future. These changes may also break +backwards comaptibility to older releases. + +We are also open to suggestions for API improvements. + ## Using the rewriter All rewriter functions are accessed via `meson rewrite`. The meson rewriter