Skip to content

Commit bfb6304

Browse files
committed
minor fixes: discharge of undefined tags warns by default
1 parent 2fb3d0c commit bfb6304

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

text/0000-safety-tags.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -250,18 +250,18 @@ invariants, and define the new tag on `delegation` function. This practice exten
250250
delegation of multiple tag discharges:
251251

252252
```rust
253-
#[safety::requires { MyInvaraint = "Invariants of A and C, but could be a more contextual name." }]
253+
#[safety::requires { MyInvariant = "Invariants of A and C, but could be a more contextual name." }]
254254
unsafe fn delegation() {
255255
unsafe {
256-
#[safety::checked { A = "delegated to the caller's MyInvaraint", B }]
256+
#[safety::checked { A = "delegated to the caller's MyInvariant", B }]
257257
foo();
258-
#[safety::checked { C = "delegated to the caller's MyInvaraint", D }]
258+
#[safety::checked { C = "delegated to the caller's MyInvariant", D }]
259259
bar();
260260
}
261261
}
262262
```
263263

264-
Note that discharing a tag that is not defined will raise a hard error.
264+
Note that discharing a tag that is not defined will raise a warning-by-default lint.
265265

266266
## Safety Tags are a Part of an Unsafe Function
267267

@@ -289,7 +289,7 @@ NOTE:
289289
* `requires` or `checked` can be specified multiple times, and they will be merged together.
290290
* Duplicate tags in `requires` will trigger errors.
291291
* Duplicate tags in `checked` will trigger warning-by-default diagnostics.
292-
* the scope of a tag is limited to the defined unsafe function, so identical tag name on different
292+
* the scope of a tag is limited to the defining unsafe function, so identical tag name on different
293293
unsafe functions won't affect with each other.
294294

295295
## Auto Generate Safety Docs from Tags

0 commit comments

Comments
 (0)