diff options
| author | Tristan van Berkom <tristan@codethink.co.uk> | 2020-09-11 12:49:32 +0900 |
|---|---|---|
| committer | Tristan van Berkom <tristan@codethink.co.uk> | 2020-09-12 17:43:43 +0900 |
| commit | 7be64b784448e47c44debfdefb5e8e8aa1d9db35 (patch) | |
| tree | f13b8abbb14bb59f3ccb7b145b07aa25f6a27aa4 /src/buildstream/element.py | |
| parent | 9a2b5a5f72e3face17aa08381751907bda71aaf6 (diff) | |
| download | buildstream-7be64b784448e47c44debfdefb5e8e8aa1d9db35.tar.gz | |
element.py: Added missing docstring for Element.project_name
Diffstat (limited to 'src/buildstream/element.py')
| -rw-r--r-- | src/buildstream/element.py | 10 |
1 files changed, 10 insertions, 0 deletions
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 |