diff options
| author | bors <bors@rust-lang.org> | 2024-01-05 15:23:11 +0000 |
|---|---|---|
| committer | bors <bors@rust-lang.org> | 2024-01-05 15:23:11 +0000 |
| commit | d3dfecbd418e8518f20f3a0660fdc204b07736c1 (patch) | |
| tree | b26ae761843dd5b6a78a141ce7df637993fb6f23 /tests/debuginfo/enum-thinlto.rs | |
| parent | 2d6c2386f529f33a2e614727b3e41982940abbdd (diff) | |
| parent | ef35e82ea3d40ba271e97764c5b9868f7297d318 (diff) | |
| download | rust-d3dfecbd418e8518f20f3a0660fdc204b07736c1.tar.gz rust-d3dfecbd418e8518f20f3a0660fdc204b07736c1.zip | |
Auto merge of #12066 - y21:issue12048, r=Alexendoo
Don't look for safety comments in doc tests
Fixes #12048.
What happened in the linked issue is that the lint checks for lines that start with `//` and have `SAFETY:` somewhere in it above the function item.
This works for regular comments, but when the `//` is the start of a doc comment (e.g. `/// // SAFETY: ...`) and it's part of a doc test (i.e. within \`\`\`), we probably shouldn't lint that, since the user most likely meant to refer to a different node than the one currently being checked. For example in the linked issue, the safety comment refers to `unsafe { *five_pointer }`, but the lint believes it's part of the function item.
We also can't really easily test whether the `// SAFETY:` comment within a doc comment is necessary or not, since I think that would require creating a new compiler session to re-parse the contents of the doc comment. We already do this for one of the doc markdown lints, to look for a main function in doc tests, but I don't know how to feel about doing that in more places, so probably best to just ignore them?
changelog: [`unnecessary_safety_comment`]: don't look for safety comments in doc tests
Diffstat (limited to 'tests/debuginfo/enum-thinlto.rs')
0 files changed, 0 insertions, 0 deletions
