From 674afe9423d991a91b36fd15902db9027b46e6a6 Mon Sep 17 00:00:00 2001 From: Tristan Van Berkom Date: Mon, 8 Oct 2018 18:07:45 +0900 Subject: CONTRIBUTING.rst: Added a note that public API objects should be exposed from __init__.py --- CONTRIBUTING.rst | 3 +++ 1 file changed, 3 insertions(+) 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 ~~~~~~~~~~~~~~~~~~~~~~ -- cgit v1.2.1