_yaml.py: Fixing inconsistently named API _yaml.validate_node()

All of the _yaml APIs which deal with a node (dictionary loaded
from YAML) are named _yaml.node_foo(), _yaml.node_bar(), _yaml.node_baz()
etc, except for this one glaring exception.

Also added a missing internal API documenting comment for _yaml.node_validate()

Also updated all callers to _yaml.validate_node() to now call _yaml.node_validate().

1 files changed, 15 insertions, 1 deletions

diff --git a/buildstream/_yaml.py b/buildstream/_yaml.py
index 9823f7ca3..0922bdbda 100644
--- a/buildstream/_yaml.py
+++ b/buildstream/_yaml.py
@@ -594,7 +594,21 @@ def node_sanitize(node):
     return node
 
 
-def validate_node(node, valid_keys):
+# node_validate()
+#
+# Validate the node so as to ensure the user has not specified
+# any keys which are unrecognized by buildstream (usually this
+# means a typo which would otherwise not trigger an error).
+#
+# Args:
+#    node (dict): A dictionary loaded from YAML
+#    valid_keys (list): A list of valid keys for the specified node
+#
+# Raises:
+#    LoadError: In the case that the specified node contained
+#               one or more invalid keys
+#
+def node_validate(node, valid_keys):
 
     # Probably the fastest way to do this: https://stackoverflow.com/a/23062482
     valid_keys = set(valid_keys)