Rollup merge of rust-lang#122277 - RalfJung:BorrowedCursor, r=cuviper

matthiaskrgr · web-flow · commit ff09d32d8321 · 2024-03-10T22:16:42.000+01:00
BorrowedCursor docs clarification

If one reads the `BorrowedCursor` docs without having seen `BorrowedBuf` before, it is quite easy to assume that "unfilled" and "uninit" are synonyms.
diff --git a/library/core/src/io/borrowed_buf.rs b/library/core/src/io/borrowed_buf.rs
@@ -139,9 +139,11 @@ impl<'data> BorrowedBuf<'data> {
     }
 }
 
-/// A writeable view of the unfilled portion of a [`BorrowedBuf`](BorrowedBuf).
+/// A writeable view of the unfilled portion of a [`BorrowedBuf`].
+///
+/// The unfilled portion consists of an initialized and an uninitialized part; see [`BorrowedBuf`]
+/// for details.
 ///
-/// Provides access to the initialized and uninitialized parts of the underlying `BorrowedBuf`.
 /// Data can be written directly to the cursor by using [`append`](BorrowedCursor::append) or
 /// indirectly by getting a slice of part or all of the cursor and writing into the slice. In the
 /// indirect case, the caller must call [`advance`](BorrowedCursor::advance) after writing to inform

Original file line number	Diff line number	Diff line change
`@@ -139,9 +139,11 @@ impl<'data> BorrowedBuf<'data> {`
`139`	`139`	`}`
`140`	`140`	`}`
`141`	`141`
`142`		-/// A writeable view of the unfilled portion of a [`BorrowedBuf`](BorrowedBuf).
	`142`	+/// A writeable view of the unfilled portion of a [`BorrowedBuf`].
	`143`	`+///`
	`144`	+/// The unfilled portion consists of an initialized and an uninitialized part; see [`BorrowedBuf`]
	`145`	`+/// for details.`
`143`	`146`	`///`
`144`		-/// Provides access to the initialized and uninitialized parts of the underlying `BorrowedBuf`.
`145`	`147`	/// Data can be written directly to the cursor by using [`append`](BorrowedCursor::append) or
`146`	`148`	`/// indirectly by getting a slice of part or all of the cursor and writing into the slice. In the`
`147`	`149`	/// indirect case, the caller must call [`advance`](BorrowedCursor::advance) after writing to inform