BayesicFitting Coding Style Notes

Here I present my style rules, developed over more that 40 years of programming. I was quite pleased when I learned that they mostly comply with PEP 8.

Naming conventions

Coding conventions

Code statements should read like sentences optimized for the user/coder to read. The computer does not care as long as it is grammatically correct. See Obfuscated C, a competition in writing unreadable, but working code for a bad example.


All classes and methods have a document string in which the usage is explained. The attributes of the classes and the parameters of the methods are also listed and explained. Some minimal examples are present in the class documentation.