Good Practice Notes

A section to jot down quick tips and notes as a community over time…

• Ensure you backup your code!
• Create meaningful variable names.
• Leave comments for yourself on blocks of code. (Usually it’s not necessary, though, to create a comment for each line.) These can be very useful if you come back to a script or block of code after a month or two (or longer). This can also be useful if others are working on your code.
• If you write functions, add a docstring that explains how (and why) to use the function
• Use a linting tool, such as pylint. This will give a score to your code out of ten, and prompt you to follow common practice with your code, for example variable names, writing comments/docstrings etc.