don't look for safety comments in codeblocks

This commit is contained in:
y21 2024-01-01 02:20:46 +01:00
parent 174a0d7be6
commit ef35e82ea3
2 changed files with 30 additions and 1 deletions

View File

@ -681,11 +681,19 @@ fn text_has_safety_comment(src: &str, line_starts: &[RelativeBytePos], start_pos
.filter(|(_, text)| !text.is_empty()); .filter(|(_, text)| !text.is_empty());
let (line_start, line) = lines.next()?; let (line_start, line) = lines.next()?;
let mut in_codeblock = false;
// Check for a sequence of line comments. // Check for a sequence of line comments.
if line.starts_with("//") { if line.starts_with("//") {
let (mut line, mut line_start) = (line, line_start); let (mut line, mut line_start) = (line, line_start);
loop { loop {
if line.to_ascii_uppercase().contains("SAFETY:") { // Don't lint if the safety comment is part of a codeblock in a doc comment.
// It may or may not be required, and we can't very easily check it (and we shouldn't, since
// the safety comment isn't referring to the node we're currently checking)
if line.trim_start_matches("///").trim_start().starts_with("```") {
in_codeblock = !in_codeblock;
}
if line.to_ascii_uppercase().contains("SAFETY:") && !in_codeblock {
return Some(start_pos + BytePos(u32::try_from(line_start).unwrap())); return Some(start_pos + BytePos(u32::try_from(line_start).unwrap()));
} }
match lines.next() { match lines.next() {

View File

@ -73,4 +73,25 @@ fn main() {
} }
} }
mod issue_12048 {
pub const X: u8 = 0;
/// Returns a pointer to five.
///
/// # Examples
///
/// ```
/// use foo::point_to_five;
///
/// let five_pointer = point_to_five();
/// // Safety: this pointer always points to a valid five.
/// let five = unsafe { *five_pointer };
/// assert_eq!(five, 5);
/// ```
pub fn point_to_five() -> *const u8 {
static FIVE: u8 = 5;
&FIVE
}
}
fn main() {} fn main() {}