Mercurial > p > roundup > code
changeset 7688:c09192e21faa
doc: add statement on less stable nature of using interfaces.py
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Sun, 29 Oct 2023 14:54:32 -0400 |
| parents | 4dda4a9dfe0b |
| children | 29dba38a852a |
| files | doc/reference.txt |
| diffstat | 1 files changed, 10 insertions(+), 1 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/reference.txt Sun Oct 29 13:18:36 2023 -0400 +++ b/doc/reference.txt Sun Oct 29 14:54:32 2023 -0400 @@ -1561,8 +1561,17 @@ 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 ================