summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTristan Maat <tm@tlater.net>2020-01-09 18:01:29 +0000
committerBenjamin Schubert <contact@benschubert.me>2020-03-20 11:29:56 +0000
commit18a54950efb50fb15b78831e90725dc2a13db261 (patch)
treedf535337d9de4dde79a0ee45555801de13aaa080
parentc7e2b993d679a961114884bb28850001788d44be (diff)
downloadbuildstream-18a54950efb50fb15b78831e90725dc2a13db261.tar.gz
node.pyx: Add note on node exceptions in pluginstlater/node-exceptions
-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
----------