More documentation improvements.

This commit is contained in:
Eric Traut 2020-09-04 14:51:40 -07:00
parent 4fa40fba75
commit 0a65625e03

View File

@ -43,6 +43,22 @@ Pyright can be run as either a VS Code extension or as a node-based command-line
# JSON Output
If the “--outputjson” option is specified on the command line, diagnostics are output in JSON format. The JSON structure is as follows:
```javascript
{
version: string,
time: string,
diagnostics: Diagnostic[],
summary: {
filesAnalyzed: number,
errorCount: number,
warningCount: number,
timeInSec: number
}
}
```
Each Diagnostic is formatted output in the following format:
```javascript
{
file: string,
@ -61,4 +77,4 @@ If the “--outputjson” option is specified on the command line, diagnostics a
}
```
Line and character numbers are zero-based.
Diagnostic line and character numbers are zero-based.