Add compatibility warning for the Python API (#1613)

Signed-off-by: brycegbrazen <[email protected]>
AcademySoftwareFoundation · Feb 5, 2024 · 7c2bd04 · 7c2bd04
1 parent aff89bd
commit 7c2bd04
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -2,6 +2,12 @@
 Python API
 ==========
 
+.. warning::
+   Please note the following warnings prior to using the Rez Python API:
+
+   * We try our best to not break users, but there are no compatibility guarantees between different versions of Rez.
+   * The Python API does not currently support rereading from configuration files, or changing to new configuration files after the Python API has initially been imported. If you need to support this functionality, prefer the CLI instead.
+
 .. autosummary::
    :toctree: api
    :recursive: