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

docs: clarify pending test output wording #3133

Closed
boneskull opened this issue Dec 9, 2017 · 4 comments · Fixed by #3282
Closed

docs: clarify pending test output wording #3133

boneskull opened this issue Dec 9, 2017 · 4 comments · Fixed by #3282
Labels
area: documentation anything involving docs or mochajs.org good first issue new contributors should look here! status: accepting prs Mocha can use your help with this one!

Comments

@boneskull
Copy link
Member

From @rcjsuen on April 14, 2017 13:26

In the index.md, it says...

Pending tests will be reported as such.

...and that's all it says. There is no example output provided with the "as such" claim.

Copied from original issue: mochajs/old-mochajs-site#78

@boneskull
Copy link
Member Author

From @ScottFreeCode on April 14, 2017 18:30

Examples of output don't accompany most of the stuff in this document directly, except for one in the very beginning "getting started" section. Most of the examples of output (including some with pending or skipped tests) are in the reporters section.

(That's not necessarily to say it should be that way, just to note that the pending tests section is in this regard consistent with the rest and that output examples are currently available in a dedicated section.)

@boneskull
Copy link
Member Author

From @rcjsuen on April 15, 2017 6:44

My concern is not that "the pending tests section don't have any sample output", it is that the sentence claims "Pending tests will be reported as such." but then proceeds to not provide any sample output. If the sentence didn't exist then it wouldn't matter to me.

To me, "Pending tests will be reported as such." is similar to a "look at the following figure". However, what follows here is nothing. That is what bothers me.

@boneskull
Copy link
Member Author

From @ScottFreeCode on April 15, 2017 16:45

Hmm... I always read this as closer to "pending tests will be reported as pending" -- which, while it sounds redundant when phrased that way, implies that 1) pending tests still get reported and 2) they don't get misleadingly reported as passed or cause the test-suite to count as failed. But I can see where, modulo punctuation, it could be read more like "pending tests will be reported like so:" (and then nothing). Those two points that ought to be conveyed could probably be clearer, perhaps at the expense of a little less brevity.

What if it were changed to something like, "Such incomplete tests will be reported as pending, giving an indicator of their status in the test results while not counting them as failures"?

@boneskull
Copy link
Member Author

From @rcjsuen on April 16, 2017 2:34

Yeah, I realized from this conversation that it was written to mean "Pending tests will be reported as pending".

How about...?

Such incomplete tests will still be included in the test results but as a pending test and not as a failure.

I wanted to use the word "still" to emphasize that while the function itself was empty it would still be included in the test result.

@boneskull boneskull changed the title Pending tests don't show any example output docs: clarify pending test output wording Dec 9, 2017
@boneskull boneskull added area: documentation anything involving docs or mochajs.org status: accepting prs Mocha can use your help with this one! good first issue new contributors should look here! labels Dec 9, 2017
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 good first issue new contributors should look here! status: accepting prs Mocha can use your help with this one!
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant