summaryrefslogtreecommitdiff
path: root/src/buildstream/source.py
diff options
context:
space:
mode:
authorBenjamin Schubert <ben.c.schubert@gmail.com>2019-07-12 12:20:29 +0100
committerbst-marge-bot <marge-bot@buildstream.build>2019-07-15 14:14:03 +0000
commit0a00c89c351af9b74a0b274d2e14422ad5c880c4 (patch)
tree5a4f569fd67438cc6d80928a985e47b7ccb1762a /src/buildstream/source.py
parentf48d173461aa1bc729474a996f81f218728bb18b (diff)
downloadbuildstream-0a00c89c351af9b74a0b274d2e14422ad5c880c4.tar.gz
plugins: Update public documentation to be correct with the new Nodes
We need to update every place where we were passing a yaml 'dict' to now pass a 'MappingNode'
Diffstat (limited to 'src/buildstream/source.py')
-rw-r--r--src/buildstream/source.py6
1 files changed, 3 insertions, 3 deletions
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.