Code review comment for lp://qastaging/~elopio/ubuntu-autopilot-tests/content-hub-address-book

Revision history for this message
VĂ­ctor R. Ruiz (vrruiz) wrote :

All classes and functions should have a docstring that briefly describes them.

44 + class AddressBookIntegrationWithGalleryTestCase(tests.IntegrationTestCase):
45 + """ Test the address book with the gallery app """

54 + def get_gallery_app_proxy_object(self):
55 + """ Returns the proxy object of the Gallery App """

If a test goes through some steps, add some comments in the code. This helps others developers to understand the code. Although code should be self-explanatory, some docstrings are even better.

etc.

« Back to merge proposal