summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2018-10-08 18:07:45 +0900
committerTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2018-10-08 18:07:45 +0900
commit674afe9423d991a91b36fd15902db9027b46e6a6 (patch)
tree49ed1298a8c95d541af80d52c04d3566400a7f51
parentba905e3a784c8bed06be85e02af2227aef6fa14b (diff)
downloadbuildstream-674afe9423d991a91b36fd15902db9027b46e6a6.tar.gz
CONTRIBUTING.rst: Added a note that public API objects should be exposed from __init__.py
-rw-r--r--CONTRIBUTING.rst3
1 files changed, 3 insertions, 0 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 95a32ef10..6493979f0 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -546,6 +546,9 @@ prefixed with a single underscore, and are not imported in BuildStream's the mas
In this case, the *"API Private"* functions are prefixed with a single underscore.
+Any objects which are a part of the *"Public API Surface"* should be exposed via the
+toplevel ``__init__.py`` of the ``buildstream`` package.
+
File naming convention
~~~~~~~~~~~~~~~~~~~~~~