(documentation) Inconsistent formatting of reporter names

[Lindsay-Needs-Sleep]

The report section of the documentation has inconsistent formatting.

eg:

• The xunit reporter..
• The Landing Strip (landing) reporter...
• The dot matrix (or "dot") reporter...
• The "min" reporter...
• This is the default reporter. The "spec" reporter...
• The HTML reporter...

I believe the main purpose of the quoted or code-blocked text is to tell you what exact string names you should use when indicating your desired reporter. I would say none of these formats do a good job at explicitly stating that. It is more a hint that you then have to use as a guess.

Additionally, it appears that the reporters have multiple acceptable names. (Possibly dependent on whether you are running in node or on the browser?)

In addition to the existing formats, I would like to suggest a format something like this for clarity:

JSON Stream

Names: "JSONStream" or "json-stream"
The JSON stream reporter outputs newline-delimited JSON "events" as they occur, beginning with a "start" event, followed by test passes or failures, and then the final "end" event.

(Or maybe no alternate names at all? [Their existence seems to be unnecessary, separate issue in the possible future. Though, if people agree that the alternate names should not be encouraged, then only the preferred name should be in the documentation.])

I created this issue because I didn't realize just making the the reporters all follow the most common format would be a big deal. I had originally tacked this onto a different PR. It has since been removed. Another issue I created also attracted similar attention.

Here are the previously mentioned issues / pull requests:

• PR Added documentation on how to specify the reporter for browser mocha #4026
• Issue JSON Stream documentation #4027 & PR Fix Json Stream Reporter documentation #4037

I will be stepping back from this conversation as I don't have a very strong opinion about this either way, and have already spent way to much time redoing commits for this cosmetic change.