Add sentence punctuation and links in Option docs.

This commit is contained in:
Kevin Reid
2021-09-04 11:17:34 -07:00
parent 34c1fce50b
commit c2f432058c
+5 -5
View File
@@ -1173,7 +1173,7 @@ pub fn xor(self, optb: Option<T>) -> Option<T> {
// Entry-like operations to insert a value and return a reference
/////////////////////////////////////////////////////////////////////////
/// Inserts `value` into the option then returns a mutable reference to it.
/// Inserts `value` into the option, then returns a mutable reference to it.
///
/// If the option already contains a value, the old value is dropped.
///
@@ -1397,7 +1397,7 @@ pub fn zip_with<U, F, R>(self, other: Option<U>, f: F) -> Option<R>
}
impl<T, U> Option<(T, U)> {
/// Unzips an option containing a tuple of two options
/// Unzips an option containing a tuple of two options.
///
/// If `self` is `Some((a, b))` this method returns `(Some(a), Some(b))`.
/// Otherwise, `(None, None)` is returned.
@@ -1500,7 +1500,7 @@ pub fn cloned(self) -> Option<T> {
}
impl<T: Default> Option<T> {
/// Returns the contained [`Some`] value or a default
/// Returns the contained [`Some`] value or a default.
///
/// Consumes the `self` argument then, if [`Some`], returns the contained
/// value, otherwise if [`None`], returns the [default value] for that
@@ -1561,7 +1561,7 @@ impl<T: DerefMut> Option<T> {
/// Converts from `Option<T>` (or `&mut Option<T>`) to `Option<&mut T::Target>`.
///
/// Leaves the original `Option` in-place, creating a new one containing a mutable reference to
/// the inner type's `Deref::Target` type.
/// the inner type's [`Deref::Target`] type.
///
/// # Examples
///
@@ -2039,7 +2039,7 @@ fn from_residual(residual: Option<convert::Infallible>) -> Self {
}
impl<T> Option<Option<T>> {
/// Converts from `Option<Option<T>>` to `Option<T>`
/// Converts from `Option<Option<T>>` to `Option<T>`.
///
/// # Examples
///