diff options
| author | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2018-10-08 18:05:18 +0900 |
|---|---|---|
| committer | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2018-10-08 18:05:18 +0900 |
| commit | ba905e3a784c8bed06be85e02af2227aef6fa14b (patch) | |
| tree | b4c91b66d87087168ba6bc20f2dc40e9b15af949 /CONTRIBUTING.rst | |
| parent | abb9fb987e760ff8c2a7b931f179d23498197b1a (diff) | |
| download | buildstream-ba905e3a784c8bed06be85e02af2227aef6fa14b.tar.gz | |
CONTRIBUTING.rst: Correcting `Context` example in the "imports" section
This example is very outdated and comes from pre 1.0 when the Context
object was going to be public API. Just corrected the example made about
imports to import the `Context` object from `._context` instead of `.context`.
Diffstat (limited to 'CONTRIBUTING.rst')
| -rw-r--r-- | CONTRIBUTING.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index c0d80749f..95a32ef10 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -572,11 +572,11 @@ Module imports inside BuildStream are done with relative ``.`` notation **Good**:: - from .context import Context + from ._context import Context **Bad**:: - from buildstream.context import Context + from buildstream._context import Context The exception to the above rule is when authoring plugins, plugins do not reside in the same namespace so they must |