PEPs (Python Enhancement Proposals) are design documents for Python. They are primarily aimed at developers of features in the language, but some also contain clear definitions of how to use the language well. The most important of these is PEP8, but PEP257 is also of relevance.
On top of these core language definitions, there are ‘house styles’ for particular organisations or code bases, to ensure a consistent style of code, comments etc to both developers and users.
Further, there are many documents with suggestions on how to write good code, clear comments etc. since these are things you will be marked on, you should pay some attention to these.
profLewis
commented
2 years ago
More on style guides/PEPs
PEPs (Python Enhancement Proposals) are design documents for Python. They are primarily aimed at developers of features in the language, but some also contain clear definitions of how to use the language well. The most important of these is PEP8, but PEP257 is also of relevance.
On top of these core language definitions, there are ‘house styles’ for particular organisations or code bases, to ensure a consistent style of code, comments etc to both developers and users.
Further, there are many documents with suggestions on how to write good code, clear comments etc. since these are things you will be marked on, you should pay some attention to these.
Full list of PEPs
https://www.python.org/dev/peps/
Most relevant PEPs
doc strings:
https://www.python.org/dev/peps/pep-0257/
code style: pep8
https://www.python.org/dev/peps/pep-0008/
Further pep8 advice:
https://realpython.com/python-pep8/
house styles
https://google.github.io/styleguide/pyguide.htm
comments
https://realpython.com/python-comments-guide/