Learning Python Application Development

Summary

You learned how to document the code using the RST format. The chapter introduced the Sphinx document generator that was used to create an HTML documentation for our application code. You also learned about some important Python coding standards that helped improve readability. Finally, we saw how to check our application code for errors and style violations using code analysis.

In an ideal world, you wish your code fully confirms to the coding convention. Often, that is not the case for various reasons, ranging from new team members to tight project deadlines. Sometimes, to make it compliant with the coding standards, you will need to refactor it at a later stage. While doing so, you will also need to make sure no functionality gets broken. ...