update docs with latest cli options #3432
Conversation
Signed-off-by: Outsider <[email protected]>
|
@markowsiak I like to not show I feel it is another issue. So, I open a issue for it. |
| -w, --watch watch files for changes | ||
| --check-leaks check for global variable leaks | ||
| --full-trace display the full stack trace | ||
| --compilers <ext>:<module>,... use the given module(s) to compile files | ||
| --compilers <ext>:<module>,... use the given module(s) to compile files (default: ) |
There was a problem hiding this comment.
Don't understand why you merged this with the obvious fix not done.
Add [] back as the default value.
There was a problem hiding this comment.
Why did you leave comments here?
This PR was to update doc because it is outdated. So, we found [] problem here.
I will update them in #3529 .
There was a problem hiding this comment.
Let comments here because this is where the other half of the "commander" problem went.
There was a problem hiding this comment.
However, this PR just update our docs.
The real problem is mocha binary print like that, not docs.
At that time, somebody asked why some flags are missing in the document. So, I found the issue when I make this PR. I separated the PR because this PR is for making the document up-to-date.
| --debug-brk enable node's debugger breaking on the first line | ||
| --globals <names> allow the given comma-delimited global [names] | ||
| --globals <names> allow the given comma-delimited global [names] (default: ) |
There was a problem hiding this comment.
Add [] back as the default value.
| --delay wait for async suite definition | ||
| --allow-uncaught enable uncaught errors to propagate | ||
| --forbid-only causes test marked with only to fail the suite | ||
| --forbid-pending causes pending tests and test marked with skip to fail the suite | ||
| --file <file> include a file to be ran during the suite (default: ) |
There was a problem hiding this comment.
Add [] back as the default value.
| --delay wait for async suite definition | ||
| --allow-uncaught enable uncaught errors to propagate | ||
| --forbid-only causes test marked with only to fail the suite | ||
| --forbid-pending causes pending tests and test marked with skip to fail the suite | ||
| --file <file> include a file to be ran during the suite (default: ) | ||
| --exclude <file> a file or glob pattern to ignore (default: ) |
There was a problem hiding this comment.
Add [] back as the default value.
| @@ -740,7 +740,6 @@ Mocha supports the `err.expected` and `err.actual` properties of any thrown `Ass | |||
| ```text | |||
There was a problem hiding this comment.
Markup here should probably be "```console" as we're showing screen output.
There was a problem hiding this comment.
Not completely sure why you merged this; it contains as many problems as it solved.
Myself, I always just ran the project binary with --help to ensure the "README" help matched.
It was ofttimes illuminating what had gotten screwed up.
Perhaps Mocha should follow the same process.
Please make the requested corrections.
|
I don't understand what you point out. |
|
Nvm. I guess I see what you did now. |
In docs, CLI usage is outdated.
I updated them with current CLI options.