Skip to content

Commit

Permalink
doc: add statement on less stable nature of using interfaces.py
Browse files Browse the repository at this point in the history
  • Loading branch information
rouilj committed Oct 29, 2023
1 parent 9e64072 commit abdacee
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion doc/reference.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
<customizing.html#changing-how-the-core-code-works>`_ for examples.
<customizing.html#changing-how-the-core-code-works>`_ for examples
of using interfaces.py.

Database Content
================
Expand Down

0 comments on commit abdacee

Please sign in to comment.