Over code examples I see that Python syntax is being used. And also I see the "Python" tag provided by the repository as one of the languages of the project. And since the project is about differing good from bad - I propose that ALL of the Python code examples should follow the PEP8 guidelines.
For example, in the fallacious method name file function names use camelCase. Like "getFoos". It is against the PEP8 functions naming convention:
Function names should be lowercase, with words separated by underscores as necessary to improve readability.
So function names should be represented like "get_foos", using snake_case.
P.S. and may be it would be better to highlight Python as examples language explicitly?
Over code examples I see that Python syntax is being used. And also I see the "Python" tag provided by the repository as one of the languages of the project. And since the project is about differing good from bad - I propose that ALL of the Python code examples should follow the PEP8 guidelines.
For example, in the fallacious method name file function names use camelCase. Like "getFoos". It is against the PEP8 functions naming convention:
So function names should be represented like "get_foos", using snake_case.
P.S. and may be it would be better to highlight Python as examples language explicitly?