From 18a54950efb50fb15b78831e90725dc2a13db261 Mon Sep 17 00:00:00 2001 From: Tristan Maat Date: Thu, 9 Jan 2020 18:01:29 +0000 Subject: node.pyx: Add note on node exceptions in plugins --- src/buildstream/node.pyx | 4 ++++ 1 file changed, 4 insertions(+) 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 ---------- -- cgit v1.2.1