Skip to content

Commit d4f0c55

Browse files
committed
Fix formatting inconsistencies in config.md
- Standardize wording for input and beforeAny/afterAll fields.
1 parent 0fa21e8 commit d4f0c55

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/references/schemas/config.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ Field | Type | Description | Default
1010
$schema | string | Optional. JSON Schema for this object.<br/><br/>Accepted values: `https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/config_v3.schema.json` |
1111
configId | string | Optional. Identifier for the configuration. |
1212
configPath | string | ReadOnly. Path to the configuration file. |
13-
input | one of:<br/>- string<br/>- array of string | Optional. Path(s) to test specifications and documentation source files. May be paths to specific files or to directories to scan for files. | `.`
13+
input | one of:<br/>- string<br/>- array of string | Optional. Paths to test specifications and documentation source files. May be paths to specific files or to directories to scan for files. | `.`
1414
output | string | Optional. Path of the directory in which to store the output of Doc Detective commands. If a file path is specified, Doc Detective attempts to honor the file name specified, but file path behavior is controlled by the configured reporters. | `.`
1515
recursive | boolean | Optional. If `true` searches `input`, `setup`, and `cleanup` paths recursively for test specifications and source files. | `true`
1616
relativePathBase | string | Optional. Whether paths should be interpreted as relative to the current working directory (`cwd`) or to the file in which they're specified (`file`).<br/><br/>Accepted values: `cwd`, `file` | `file`
1717
loadVariables | string | Optional. Load environment variables from the specified `.env` file. |
1818
origin | string | Optional. Default protocol and domain to use for relative URLs. |
19-
beforeAny | one of:<br/>- string<br/>- array of string | Optional. Path(s) to test specifications to perform before those specified by `input`. Useful for setting up testing environments. |
20-
afterAll | one of:<br/>- string<br/>- array of string | Optional. Path(s) to test specifications to perform after those specified by `input`. Useful for cleaning up testing environments. |
19+
beforeAny | one of:<br/>- string<br/>- array of string | Optional. Paths to test specifications to perform before those specified by `input`. Useful for setting up testing environments. |
20+
afterAll | one of:<br/>- string<br/>- array of string | Optional. Paths to test specifications to perform after those specified by `input`. Useful for cleaning up testing environments. |
2121
detectSteps | boolean | Optional. Whether or not to detect steps in input files based on defined markup. | `true`
2222
allowUnsafeSteps | boolean | Optional. Whether or not to run potentially unsafe steps, such as those that might modify files or system state. |
2323
logLevel | string | Optional. Amount of detail to output when performing an operation.<br/><br/>Accepted values: `silent`, `error`, `warning`, `info`, `debug` | `info`

0 commit comments

Comments
 (0)