From abdacee23fa1168fcae235329a10cbce6ab6c0be Mon Sep 17 00:00:00 2001 From: John Rouillard Date: Sun, 29 Oct 2023 14:54:32 -0400 Subject: [PATCH] doc: add statement on less stable nature of using interfaces.py --- doc/reference.txt | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/doc/reference.txt b/doc/reference.txt index 33ef59bd..6c4b4b21 100644 --- a/doc/reference.txt +++ b/doc/reference.txt @@ -1561,8 +1561,17 @@ directories are not on the Python system path when interfaces.py is evaluated. You need to add library directories explictly by modifying sys.path. +Interfaces.py allows you to interact with any part of Roundup's +internals. These internals are not as stable as defined interfaces +(e.g. extensions. detectors, schema). So the code in interfaces.py is +more likely to need modification when upgrading from version to +version. While the developers attempt to keep the examples working, +it may make more sense to change the internals to make the code +clearer, add more features etc. + See `Changing How the Core Code Works -`_ for examples. +`_ for examples +of using interfaces.py. Database Content ================