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

chore(docs): rewording pending tests #3282

Merged
merged 3 commits into from Mar 20, 2018

Conversation

ematipico
Copy link
Contributor

Description of the Change

Fixes #3133
Rewording of part of the documentation

Alternate Designs

Based on the proposed rewording, I proposed the one that makes more sense

Why should this be in core?

N/A

Benefits

Better understanding for users

Possible Drawbacks

None

Applicable issues

Bugfix

@jsf-clabot
Copy link

jsf-clabot commented Mar 12, 2018

CLA assistant check
All committers have signed the CLA.

@coveralls
Copy link

coveralls commented Mar 12, 2018

Coverage Status

Coverage increased (+0.05%) to 90.086% when pulling 327743a on ematipico:chore/rewording-doc into d76f490 on mochajs:master.

@outsideris outsideris added the area: documentation anything involving docs or mochajs.org label Mar 13, 2018
Copy link
Member

@boneskull boneskull left a comment

Choose a reason for hiding this comment

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

Thanks for looking at this! I have a suggestion.

docs/index.md Outdated
@@ -419,7 +419,7 @@ describe('Array', function() {
});
```

Pending tests will be reported as such.
Such incomplete tests will still be included in the test results but as a pending test and not as a failure.
Copy link
Member

Choose a reason for hiding this comment

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

Hmm, this is a bit of a run-on sentence. Maybe:

"Pending tests will be included in the test results, and marked as pending. A pending test is not considered a failed test."

@boneskull boneskull added the semver-patch implementation requires increase of "patch" version number; "bug fixes" label Mar 18, 2018
@ematipico
Copy link
Contributor Author

@boneskull I updated the text based on your suggestion

@boneskull boneskull added this to the next milestone Mar 20, 2018
@boneskull boneskull merged commit 19b764d into mochajs:master Mar 20, 2018
@ematipico ematipico deleted the chore/rewording-doc branch March 20, 2018 20:12
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.

docs: clarify pending test output wording
5 participants