summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAngelos Evripiotis <jevripiotis@bloomberg.net>2018-10-08 07:40:41 -0400
committerTristan Van Berkom <tristan.van.berkom@gmail.com>2018-10-09 09:12:45 +0000
commit3ed26a473cd5b1aa41311e216b4d84d0ba0fb288 (patch)
treecdfc26853c050b9ea918a1ffc1203d369b49a4d2
parent6d02e2695d3fe3955b8285a14d651bb111fe4498 (diff)
downloadbuildstream-3ed26a473cd5b1aa41311e216b4d84d0ba0fb288.tar.gz
contributing.rst: de-paren subclass example
It seems easier to read when separated into two sentences.
-rw-r--r--CONTRIBUTING.rst6
1 files changed, 3 insertions, 3 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 59d3bb3bf..066495d68 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -494,10 +494,10 @@ reference on how the PEP-8 defines public and non-public.
A private symbol must be denoted by a leading underscore.
-* When a class can have subclasses (for example, the ``Sandbox`` or ``Platform``
+* When a class can have subclasses, then private symbols should be denoted
+ by two leading underscores. For example, the ``Sandbox`` or ``Platform``
classes which have various implementations, or the ``Element`` and ``Source``
- classes which plugins derive from), then private symbols should be denoted
- by two leading underscores.
+ classes which plugins derive from.
The double leading underscore naming convention invokes Python's name
mangling algorithm which helps prevent namespace collisions in the case