On Nov 25, 2013, at 12:03 PM, "Ben Mahler" <[email protected]> wrote >> >> Vinod Kone wrote: >> I'm not convinced about repeating the specific details of "how" in the >> comment when it is already in the comments. I think our abstracts are pretty >> easy to understand what's happening (StartMaster(), StartSlave(), >> driver.start() etc). >> >> That said I added couple more comments in the test to make you happy :) > > Appreciate it! Although I still don't see a summary about what this test is > doing ;) > > Think of this as a summary rather than repetition, sometimes we have to think > pretty hard about how to test things that it's good to summarize this for > others trying to understand the test. In complicated tests, having both what > is being tested, along with how it's being tested at the top of the test > seems useful, no? >
+1 on summarizing a test's purpose As a newbie reading tests it'll make things much, much easier. Recreating a test's purpose from code plus test name is backwards to me. It'll also be clearer if we document which expectations are truly part of the test.
