Difference between revisions of "OBPlayer Code Style Guide"

From OpenBroadcaster
Jump to: navigation, search
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
OBPLayer rewrite supports Python 3
 
OBPLayer rewrite supports Python 3
  
OBPlayer was originally written in Python (v2) and uses the style guide described at [http://www.python.org/dev/peps/pep-0008/| http://www.python.org/dev/peps/pep-0008/]
+
OBPlayer was originally written in Python (v2) and uses the style guide described at [https://www.python.org/dev/peps/pep-0008/ http://www.python.org/]
  
 
Exceptions
 
Exceptions

Latest revision as of 15:50, 6 April 2018

OBPLayer rewrite supports Python 3

OBPlayer was originally written in Python (v2) and uses the style guide described at http://www.python.org/

Exceptions

2-space tabs are used rather than 4-space tabs.

In case of other consistent exceptions to the Python style guide, follow the style used in the Remote code. In case of other inconsistent exceptions to the Python style guide, follow the Python style guide. This section should be updated with other consistent exceptions. Important Style Elements

The following are important style elements consistent with the Python style guide.

Spaces are used rather than tabs.

Naming conventions should follow the Python style guide strictly:

- ClassNamesUseCapsWords

- function_names, method_names, variable_names use lowercase_with_underscores.

- CONSTANTS use UPPERCASE_WITH_UNDERSCORES.