Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Python code examples don't follow PEP8 #20

Open
Rioran opened this issue Dec 25, 2023 · 1 comment
Open

Python code examples don't follow PEP8 #20

Rioran opened this issue Dec 25, 2023 · 1 comment

Comments

@Rioran
Copy link

Rioran commented Dec 25, 2023

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?

@Rioran
Copy link
Author

Rioran commented Dec 25, 2023

I guess I am rising a question: "Is the project language-dependant or not?".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant