Thanks for addressing my concerns. I still think the documentation on the tests needs tweaking. The documentation you've added does describe the expected behaviour for which we're testing, but it does it in a rather opaque way. I've pastebinned a diff of how I think the documentation should read: https://pastebin.canonical.com/83278/
Generally, comments on tests should be written as something like:
// Foo() returns an instance of Bar when its returnBar parameter is set to true.
func (suite *FooTestSuite) TestFooReturnsBarWhenReturnBarParameterIsTrue (c *gocheck.C) {
...
}
Hi Vincenzo,
Thanks for addressing my concerns. I still think the documentation on the tests needs tweaking. The documentation you've added does describe the expected behaviour for which we're testing, but it does it in a rather opaque way. I've pastebinned a diff of how I think the documentation should read: https:/ /pastebin. canonical. com/83278/
Generally, comments on tests should be written as something like:
// Foo() returns an instance of Bar when its returnBar parameter is set to true. arWhenReturnBar ParameterIsTrue (c *gocheck.C) {
func (suite *FooTestSuite) TestFooReturnsB
...
}