summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
Diffstat (limited to 'src')
-rw-r--r--src/buildstream/node.pyx4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/buildstream/node.pyx b/src/buildstream/node.pyx
index 87c2ab6d1..adc8aa04e 100644
--- a/src/buildstream/node.pyx
+++ b/src/buildstream/node.pyx
@@ -33,6 +33,10 @@ provide helper methods to validate configuration on access.
Using node methods when reading configuration will ensure that errors
are always coherently notified to the user.
+.. note:: Plugins are not expected to handle exceptions thrown by node
+ methods for the above reason; They are private. There should
+ always be a way to acquire information without resorting to
+ exception handling.
Node types
----------