"timeout" and "t.timeoutAfter" documentation / error messages.

[dmin]

The documentation doesn't give any specific information on when/how to use the timeout option or t.timeoutAfter method. I looked at the test for t.timeoutAfter but that still doesn't give much information on a real world usage. I attempted to use the timeout option in two different ways: are either of the following uses as intended (they both produce unexpected results)? Either way I'd be happy to put in a PR with a little more information on using timeout - just would like to get a little more insight on the intended usage. Original PR for timeoutAfter: #132.

Using t.plan

var test = require('tape');

test('one equals one', { timeout: 10 }, function (t) {

    t.plan(1);

    setTimeout(function () {
      t.equal(1, 1);
    }, 100);
});

Output:

TAP version 13
# one equals one
not ok 1 test timed out after 10ms
  ---
    operator: fail
  ...
ok 2 should be equal
not ok 3 plan != count
  ---
    operator: fail
    expected: 1
    actual:   2
    at: null._onTimeout (/Users/David/code/tests/tape-react/source/timeout-option-plan.js:8:9)
  ...

1..3
# tests 3
# pass  1
# fail  2

Using t.end

var test = require('tape');

test('two equals two', { timeout: 10 }, function (t) {

    t.equal("two", "two");

    setTimeout(function () {
      t.end();
    }, 100);
});

Output

TAP version 13
# two equals two
ok 1 should be equal
not ok 2 test timed out after 10ms
  ---
    operator: fail
  ...
not ok 3 .end() called twice
  ---
    operator: fail
    at: null._onTimeout (/Users/David/code/tests/tape-react/source/timeout-option-end.js:8:9)
  ...

1..3
# tests 3
# pass  1
# fail  2