From 7be64b784448e47c44debfdefb5e8e8aa1d9db35 Mon Sep 17 00:00:00 2001
From: Tristan van Berkom <tristan@codethink.co.uk>
Date: Fri, 11 Sep 2020 12:49:32 +0900
Subject: element.py: Added missing docstring for Element.project_name

---
 src/buildstream/element.py | 10 ++++++++++
 1 file changed, 10 insertions(+)

(limited to 'src/buildstream/element.py')

diff --git a/src/buildstream/element.py b/src/buildstream/element.py
index 5ba759dfe..3316d8adb 100644
--- a/src/buildstream/element.py
+++ b/src/buildstream/element.py
@@ -213,6 +213,16 @@ class Element(Plugin):
             project.ensure_fully_loaded()
 
         self.project_name = self._get_project().name
+        """The :ref:`name <project_format_name>` of the owning project
+
+        .. attention::
+
+           Combining this attribute with :attr:`Plugin.name <buildstream.plugin.Plugin.name>`
+           does not provide a unique identifier for an element within a project, this is because
+           multiple :mod:`junction <elements.junction>` elements can be used specify the same
+           project as a subproject.
+        """
+
         self.normal_name = _get_normal_name(self.name)
         """A normalized element name
 
-- 
cgit v1.2.1