1
Fork 0

Update docs too

This commit is contained in:
Jeremy Fitzhardinge 2023-10-16 12:30:27 -06:00
parent 8f0845862c
commit 8aa4fb57f1

View file

@ -11,11 +11,11 @@ If parsing the output with Rust, the
[`cargo_metadata`](https://crates.io/crates/cargo_metadata) crate provides [`cargo_metadata`](https://crates.io/crates/cargo_metadata) crate provides
some support for parsing the messages. some support for parsing the messages.
Each type of message has a `type` field which can be used to distinguish the Each type of message has a `$message_type` field which can be used to
different formats. When parsing, care should be taken to be forwards-compatible distinguish the different formats. When parsing, care should be taken
with future changes to the format. Optional values may be `null`. New fields may to be forwards-compatible with future changes to the format. Optional
be added. Enumerated fields like "level" or "suggestion_applicability" may add values may be `null`. New fields may be added. Enumerated fields like
new values. "level" or "suggestion_applicability" may add new values.
## Diagnostics ## Diagnostics
@ -32,7 +32,7 @@ Diagnostics have the following format:
```javascript ```javascript
{ {
/* Type of this message */ /* Type of this message */
"type": "diagnostic", "$message_type": "diagnostic",
/* The primary message. */ /* The primary message. */
"message": "unused variable: `x`", "message": "unused variable: `x`",
/* The diagnostic code. /* The diagnostic code.