|
|
|
Coding standards and guidelines for the QIM projects
|
|
|
|
According to ChatGPT, this is why coding conventions are important:
|
|
|
|
|
|
|
|
>>>
|
|
|
|
Coding conventions may seem like a bunch of arbitrary rules that some grumpy programmers made up to ruin your day. But fear not, for these conventions are actually your allies in the wild world of coding!
|
|
|
|
|
|
|
|
Picture this: coding conventions are like a secret handshake among developers, a universal language that helps us understand each other's code without pulling our hair out.
|
|
|
|
|
|
|
|
They bring order to the chaos, like traffic rules that prevent cars from turning into bumper cars. So, embrace these guidelines, my friend, and let them be your compass in the vast coding landscape. They'll save you from countless hours of debugging, make your code more readable, and ensure that even your future self will thank you.
|
|
|
|
|
|
|
|
Trust me, coding conventions are not just rules, they're your passport to becoming a coding rockstar! Now, go forth and conquer the code with style and panache!
|
|
|
|
>>>
|
|
|
|
|
|
|
|
So I guess it's okay if we have a few guidelines. The [Google Python Style Guide] https://google.github.io/styleguide/pyguide.html is a very good source of coding style for Python, and here's the gist of it:
|
|
|
|
|
|
|
|
### Code layout
|
|
|
|
- Limit line length to 80 characters.
|
| ... | ... | |
| ... | ... | |