diff options
Diffstat (limited to 'src/tools/clippy/src/docs/missing_safety_doc.txt')
| -rw-r--r-- | src/tools/clippy/src/docs/missing_safety_doc.txt | 26 |
1 files changed, 0 insertions, 26 deletions
diff --git a/src/tools/clippy/src/docs/missing_safety_doc.txt b/src/tools/clippy/src/docs/missing_safety_doc.txt deleted file mode 100644 index 6492eb84f..000000000 --- a/src/tools/clippy/src/docs/missing_safety_doc.txt +++ /dev/null @@ -1,26 +0,0 @@ -### What it does -Checks for the doc comments of publicly visible -unsafe functions and warns if there is no `# Safety` section. - -### Why is this bad? -Unsafe functions should document their safety -preconditions, so that users can be sure they are using them safely. - -### Examples -``` -/// This function should really be documented -pub unsafe fn start_apocalypse(u: &mut Universe) { - unimplemented!(); -} -``` - -At least write a line about safety: - -``` -/// # Safety -/// -/// This function should not be called before the horsemen are ready. -pub unsafe fn start_apocalypse(u: &mut Universe) { - unimplemented!(); -} -```
\ No newline at end of file |