Skip to content

Commit abdacee

Browse files
committed
doc: add statement on less stable nature of using interfaces.py
1 parent 9e64072 commit abdacee

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

doc/reference.txt

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1561,8 +1561,17 @@ directories are not on the Python system path when interfaces.py is
15611561
evaluated. You need to add library directories explictly by
15621562
modifying sys.path.
15631563

1564+
Interfaces.py allows you to interact with any part of Roundup's
1565+
internals. These internals are not as stable as defined interfaces
1566+
(e.g. extensions. detectors, schema). So the code in interfaces.py is
1567+
more likely to need modification when upgrading from version to
1568+
version. While the developers attempt to keep the examples working,
1569+
it may make more sense to change the internals to make the code
1570+
clearer, add more features etc.
1571+
15641572
See `Changing How the Core Code Works
1565-
<customizing.html#changing-how-the-core-code-works>`_ for examples.
1573+
<customizing.html#changing-how-the-core-code-works>`_ for examples
1574+
of using interfaces.py.
15661575

15671576
Database Content
15681577
================

0 commit comments

Comments
 (0)