From 3ed26a473cd5b1aa41311e216b4d84d0ba0fb288 Mon Sep 17 00:00:00 2001 From: Angelos Evripiotis Date: Mon, 8 Oct 2018 07:40:41 -0400 Subject: contributing.rst: de-paren subclass example It seems easier to read when separated into two sentences. --- CONTRIBUTING.rst | 6 +++--- 1 file 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 -- cgit v1.2.1