dev: correct style guide on leading-underscores-on-private-members

ArduPilot · Jul 30, 2024 · 05b438c · 05b438c
1 parent 4dbd7bb
commit 05b438c
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/dev/source/docs/style-guide.rst b/dev/source/docs/style-guide.rst
@@ -318,7 +318,7 @@ Names
 Private members
 ---------------
 
-Private members in classes should be prefixed with an underscore:
+Private members in classes may be prefixed with an underscore:
 
 **Right:**
 
@@ -329,7 +329,7 @@ Private members in classes should be prefixed with an underscore:
         int _field;
     };
 
-**Wrong:**
+**Right:**
 
 ::
 
@@ -338,6 +338,8 @@ Private members in classes should be prefixed with an underscore:
         int field;
     };
 
+The ArduPilot codebase contains a mixture of the two styles.  Either is acceptable, with a preference for no-leading-underscores in new code.
+
 Class names
 -----------