summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBenjamin Schubert <ben.c.schubert@gmail.com>2019-07-12 12:20:29 +0100
committerBenjamin Schubert <ben.c.schubert@gmail.com>2019-07-12 13:31:54 +0100
commitc5491d99719aa58170b8fdd49d4201225a1c96ee (patch)
tree50144fb5d3b60600f120cb2a69ed632c053e8b8a
parent012db3524c62426ca6e9882ea2cc9cb449347d95 (diff)
downloadbuildstream-bschubert/node-api-split.tar.gz
plugins: Update public documentation to be correct with the new Nodesbschubert/node-api-split
We need to update every place where we were passing a yaml 'dict' to now pass a 'MappingNode'
-rw-r--r--src/buildstream/element.py4
-rw-r--r--src/buildstream/plugin.py4
-rw-r--r--src/buildstream/source.py6
3 files changed, 7 insertions, 7 deletions
diff --git a/src/buildstream/element.py b/src/buildstream/element.py
index a447615a2..2d618853f 100644
--- a/src/buildstream/element.py
+++ b/src/buildstream/element.py
@@ -493,7 +493,7 @@ class Element(Plugin):
in the loaded value with the element contextual variables.
Args:
- node (dict): A dictionary loaded from YAML
+ node (`MappingNode <buildstream.node.MappingNode>`): A MappingNode loaded from YAML
member_name (str): The name of the member to fetch
default (str): A value to return when *member_name* is not specified in *node*
@@ -522,7 +522,7 @@ class Element(Plugin):
"""Fetch a list from a node member, substituting any variables in the list
Args:
- node (dict): A dictionary loaded from YAML
+ node (:class:`MappingNode <buildstream.node.MappingNode>`): A MappingNode loaded from YAML
member_name (str): The name of the member to fetch (a list)
Returns:
diff --git a/src/buildstream/plugin.py b/src/buildstream/plugin.py
index ac7b0948e..9a322ab81 100644
--- a/src/buildstream/plugin.py
+++ b/src/buildstream/plugin.py
@@ -270,7 +270,7 @@ class Plugin():
"""Configure the Plugin from loaded configuration data
Args:
- node (dict): The loaded configuration dictionary
+ node (:class:`MappingNode <buildstream.node.MappingNode>`): The loaded configuration dictionary
Raises:
:class:`.SourceError`: If it's a :class:`.Source` implementation
@@ -636,7 +636,7 @@ class Plugin():
# _get_configuring() state is up to date.
#
# Args:
- # node (dict): The loaded configuration dictionary
+ # node (buildstream.node.MappingNode): The loaded configuration dictionary
#
def _configure(self, node):
self.__configuring = True
diff --git a/src/buildstream/source.py b/src/buildstream/source.py
index 43957378d..59b6d3644 100644
--- a/src/buildstream/source.py
+++ b/src/buildstream/source.py
@@ -354,7 +354,7 @@ class Source(Plugin):
"""Loads the *ref* for this Source from the specified *node*.
Args:
- node (dict): The YAML node to load the ref from
+ node (:class:`MappingNode <buildstream.node.MappingNode>`): The YAML node to load the ref from
.. note::
@@ -391,8 +391,8 @@ class Source(Plugin):
Args:
ref (simple object): The internal source reference to set, or ``None``
- node (dict): The same dictionary which was previously passed
- to :func:`Plugin.configure() <buildstream.plugin.Plugin.configure>`
+ node (:class:`MappingNode <buildstream.node.MappingNode>`): The same dictionary which was previously passed
+ to :func:`Plugin.configure() <buildstream.plugin.Plugin.configure>`
See :func:`Source.get_ref() <buildstream.source.Source.get_ref>`
for a discussion on the *ref* parameter.