Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add --no-timeouts to docs; closes #3137 #3176

Merged
merged 2 commits into from Jan 9, 2018
Merged

add --no-timeouts to docs; closes #3137 #3176

merged 2 commits into from Jan 9, 2018

Conversation

dfberry
Copy link
Contributor

@dfberry dfberry commented Dec 24, 2017

Requirements

  • Filling out the template is required. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion.
  • All new code requires tests to ensure against regressions.

Description of the Change

add --no-timeouts to docs

Possible Drawbacks

Is this all that #3137 is asking for or is there more to be done?

Applicable issues

none - doc change only

@jsf-clabot
Copy link

jsf-clabot commented Dec 24, 2017

CLA assistant check
All committers have signed the CLA.

@coveralls
Copy link

Coverage Status

Coverage increased (+0.05%) to 90.014% when pulling eb1a9d9 on dfberry:issue/3137 into 33db6b1 on mochajs:master.

@boneskull
Copy link
Member

@dfberry Thanks!

docs/index.md Outdated
@@ -846,6 +846,10 @@ The `--reporter` option allows you to specify the reporter that will be used, de

Specifies the test-case timeout, defaulting to 2 seconds. To override you may pass the timeout in milliseconds, or a value with the `s` suffix, ex: `--timeout 2s` or `--timeout 2000` would be equivalent.

### `--no-timeouts`

Disables timeouts, given implicitly with `--debug`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Maybe we should move the note about --debug to the --debug documentation, unless it's already there, e.g. "implies --no-timeouts"
  • Let's also note that it's equivalent to --timeout 0.

@boneskull boneskull changed the title #3137 add --no-timeouts to docs; closes #3137 Dec 29, 2017
@coveralls
Copy link

Coverage Status

Coverage increased (+0.05%) to 90.018% when pulling 225733f on dfberry:issue/3137 into 33db6b1 on mochajs:master.

@boneskull boneskull added area: documentation anything involving docs or mochajs.org semver-patch implementation requires increase of "patch" version number; "bug fixes" labels Jan 7, 2018
@boneskull
Copy link
Member

Thanks!

@boneskull boneskull merged commit b2697a7 into mochajs:master Jan 9, 2018
@boneskull boneskull added this to the v5.0.0 milestone Jan 17, 2018
sgilroy pushed a commit to TwineHealth/mocha that referenced this pull request Feb 27, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation anything involving docs or mochajs.org semver-patch implementation requires increase of "patch" version number; "bug fixes"
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants