On 10/8/2025 12:56 PM, Miguel Ojeda wrote:
> On Wed, Oct 8, 2025 at 2:13 AM Alistair Popple <[email protected]> wrote:
>>
>> +/// Example:
>> +///
>> +/// let mut buf1 = [0u8; 3];
>> +/// let mut buf2 = [0u8; 5];
>> +/// let mut sbuffer = SWriteBuffer::new([&buf1, &buf2]);
>> +///
>> +/// let data = b"hellowo";
>> +/// let result = sbuffer.write_all(0, data);
>> +///
>> +/// A sliding window of slices to proceed.
> 
> Please write documentation in the expected format, i.e. using a code
> block and a header:
> 
>     https://docs.kernel.org/rust/coding-guidelines.html#code-documentation

Sorry about that. I will fix this up for the next series posting.

> Eventually, this documentation will get rendered just like the
> `kernel` crate (and the examples building/running as tests etc.),
> which requires following the expected conventions.
> 
> By the way, is the sentence "A sliding window of slices to proceed." cut?
> 
It is a typo, should be "A sliding window of slices to process". Will fix :)

thanks,

 - Joel


Reply via email to