Skip to content

Commit

Permalink
docs: introduce primary param in label
Browse files Browse the repository at this point in the history
  • Loading branch information
bvanjoi committed Nov 29, 2024
1 parent b2011f6 commit a5b549a
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ diagnostic error code: ruget::api::bad_json
- [... handler options](#-handler-options)
- [... dynamic diagnostics](#-dynamic-diagnostics)
- [... syntax highlighting](#-syntax-highlighting)
- [... primary label](#-primary-label)
- [... collection of labels](#-collection-of-labels)
- [Acknowledgements](#acknowledgements)
- [License](#license)
Expand Down Expand Up @@ -689,6 +690,37 @@ trait to [`MietteHandlerOpts`] by calling the
[`with_syntax_highlighting`](MietteHandlerOpts::with_syntax_highlighting)
method. See the [`highlighters`] module docs for more details.

#### ... primary label

You can use the `primary` parameter to `label` to indicate that the label
is the primary label.

```rust
#[derive(Debug, Diagnostic, Error)]
#[error("oops!")]
struct MyError {
#[label(primary, "main issue")]
primary_span: SourceSpan,

#[label("other label")]
other_span: SourceSpan,
}
```

The `primary` parameter can be used at most once:

```rust
#[derive(Debug, Diagnostic, Error)]
#[error("oops!")]
struct MyError {
#[label(primary, "main issue")]
primary_span: SourceSpan,

#[label(primary, "other label")] // Error: Cannot have more than one primary label.
other_span: SourceSpan,
}
```

#### ... collection of labels

When the number of labels is unknown, you can use a collection of `SourceSpan`
Expand Down

0 comments on commit a5b549a

Please sign in to comment.