Skip to content

Commit 2ad4d6f

Browse files
committed
docs: correction
1 parent 23602f0 commit 2ad4d6f

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

docs/advanced/api/vitest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,7 @@ This method can be slow because it needs to filter `--changed` flags. Do not use
226226
function mergeReports(directory?: string): Promise<TestRunResult>
227227
```
228228

229-
Merge reports from multiple runs located in the specified directory (`--merge-reports` if not specified). This value can also be set on `config.mergeReports` (by default, it will read `.vitest-reports` folder).
229+
Merge reports from multiple runs located in the specified directory (value from `--merge-reports` if not specified). This value can also be set on `config.mergeReports` (by default, it will read `.vitest-reports` folder).
230230

231231
Note that the `directory` will always be resolved relative to the working directory.
232232

packages/vitest/src/node/cli/cli-config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -802,7 +802,7 @@ export const cliOptionsConfig: VitestCLIOptions = {
802802
},
803803
mergeReports: {
804804
description:
805-
'Paths to blob reports directory. If this options is used, Vitest won\'t run any tests, it will only report previously recorded tests',
805+
'Path to a blob reports directory. If this options is used, Vitest won\'t run any tests, it will only report previously recorded tests',
806806
argument: '[path]',
807807
transform(value) {
808808
if (!value || typeof value === 'boolean') {

packages/vitest/src/node/core.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -433,7 +433,7 @@ export class Vitest {
433433
}
434434

435435
/**
436-
* Merge reports from multiple runs located in the specified directory (`--merge-reports` by default).
436+
* Merge reports from multiple runs located in the specified directory (value from `--merge-reports` if not specified).
437437
*/
438438
public async mergeReports(directory?: string): Promise<TestRunResult> {
439439
if (this.reporters.some(r => r instanceof BlobReporter)) {

0 commit comments

Comments
 (0)