Skip to content

Commit d7e3c1c

Browse files
asomersSteveLauC
authored andcommitted
Clippy::doc_overindented_list_items
Fix the lint in one file, but suppress it in src/sys/aio.rs, where the docstrings are nicely formated for reading in either plain text or html.
1 parent 99a3ea3 commit d7e3c1c

File tree

2 files changed

+8
-5
lines changed

2 files changed

+8
-5
lines changed

src/sys/aio.rs

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
//! [`cancel`](trait.Aio.html#method.cancel) or
2424
//! [`aio_cancel_all`](fn.aio_cancel_all.html), though the operating system may
2525
//! not support this for all filesystems and devices.
26+
#![allow(clippy::doc_overindented_list_items)] // It looks better this way
2627
#[cfg(target_os = "freebsd")]
2728
use std::io::{IoSlice, IoSliceMut};
2829
use std::{
@@ -572,8 +573,9 @@ impl<'a> AioRead<'a> {
572573
/// * `fd`: File descriptor to read from
573574
/// * `offs`: File offset
574575
/// * `buf`: A memory buffer. It must outlive the `AioRead`.
575-
/// * `prio`: If POSIX Prioritized IO is supported, then the operation
576-
/// will be prioritized at the process's priority level minus `prio`
576+
/// * `prio`: If POSIX Prioritized IO is supported, then the
577+
/// operation will be prioritized at the process's
578+
/// priority level minus `prio`.
577579
/// * `sigev_notify`: Determines how you will be notified of event completion.
578580
pub fn new(
579581
fd: BorrowedFd<'a>,
@@ -802,8 +804,9 @@ impl<'a> AioWrite<'a> {
802804
/// * `fd`: File descriptor to write to
803805
/// * `offs`: File offset
804806
/// * `buf`: A memory buffer. It must outlive the `AioWrite`.
805-
/// * `prio`: If POSIX Prioritized IO is supported, then the operation
806-
/// will be prioritized at the process's priority level minus `prio`
807+
/// * `prio`: If POSIX Prioritized IO is supported, then the
808+
/// operation will be prioritized at the process's
809+
/// priority level minus `prio`
807810
/// * `sigev_notify`: Determines how you will be notified of event completion.
808811
pub fn new(
809812
fd: BorrowedFd<'a>,

src/sys/signal.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1035,7 +1035,7 @@ pub fn sigprocmask(how: SigmaskHow, set: Option<&SigSet>, oldset: Option<&mut Si
10351035
/// - If less than `-1`, the signal is sent to all processes whose
10361036
/// process group ID is equal to the absolute value of `pid`.
10371037
/// * `signal` - Signal to send. If `None`, error checking is performed
1038-
/// but no signal is actually sent.
1038+
/// but no signal is actually sent.
10391039
///
10401040
/// See Also
10411041
/// [`kill(2)`](https://pubs.opengroup.org/onlinepubs/9699919799/functions/kill.html)

0 commit comments

Comments
 (0)