Clippy: Fix doc_lazy_continuation

This commit is contained in:
Serial 2024-06-11 17:34:19 -04:00 committed by Alex
parent 89adc98b8e
commit dde24d5b6d
6 changed files with 18 additions and 21 deletions

View file

@ -72,7 +72,7 @@ impl GlobalOptions {
/// The maximum number of bytes to allocate for any single tag item
///
/// This is a safety measure to prevent allocating too much memory for a single tag item. If a tag item
/// exceeds this limit, the allocator will return [`crate::error::ErrorKind::TooMuchData`].
/// exceeds this limit, the allocator will return [`ErrorKind::TooMuchData`](crate::error::ErrorKind::TooMuchData).
///
/// # Examples
///

View file

@ -167,10 +167,9 @@ impl FileType {
///
/// NOTES:
///
/// * This is for use in [`Probe::guess_file_type`], it
/// is recommended to use it that way
/// * This is for use in [`Probe::guess_file_type`], it is recommended to use it that way
/// * This **will not** search past tags at the start of the buffer.
/// For this behavior, use [`Probe::guess_file_type`].
/// For this behavior, use [`Probe::guess_file_type`].
///
/// [`Probe::guess_file_type`]: crate::probe::Probe::guess_file_type
///

View file

@ -17,9 +17,9 @@ const FRAME_ID: FrameId<'static> = FrameId::Valid(Cow::Borrowed("ETCO"));
/// Note from [the spec](https://mutagen-specs.readthedocs.io/en/latest/id3/id3v2.4.0-frames.html#event-timing-codes):
///
/// >>> Terminating the start events such as “intro start” is OPTIONAL.
/// The Not predefined synchs ($E0-EF) are for user events.
/// You might want to synchronise your music to something,
/// like setting off an explosion on-stage, activating a screensaver etc.
/// >>> The Not predefined synchs ($E0-EF) are for user events.
/// >>> You might want to synchronise your music to something,
/// >>> like setting off an explosion on-stage, activating a screensaver etc.
#[repr(u8)]
#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Debug, Hash)]
#[allow(missing_docs)]

View file

@ -247,12 +247,12 @@ impl Debug for Atom<'_> {
/// NOTES:
///
/// * This only covers the most common data types.
/// See the list of [well-known data types](https://developer.apple.com/library/archive/documentation/QuickTime/QTFF/Metadata/Metadata.html#//apple_ref/doc/uid/TP40000939-CH1-SW34)
/// for codes.
/// See the list of [well-known data types](https://developer.apple.com/library/archive/documentation/QuickTime/QTFF/Metadata/Metadata.html#//apple_ref/doc/uid/TP40000939-CH1-SW34)
/// for codes.
/// * There are only two variants for integers, which
/// will come from codes `21` and `22`. All other integer
/// types will be stored as [`AtomData::Unknown`], refer
/// to the link above for codes.
/// will come from codes `21` and `22`. All other integer
/// types will be stored as [`AtomData::Unknown`], refer
/// to the link above for codes.
#[derive(Debug, PartialEq, Eq, Clone)]
pub enum AtomData {
/// A UTF-8 encoded string

View file

@ -467,16 +467,14 @@ impl Picture {
///
/// NOTES:
///
/// * This is for reading picture data only, from
/// a [`File`](std::fs::File) for example.
/// * `pic_type` will always be [`PictureType::Other`],
/// be sure to change it accordingly if writing.
/// * This is for reading picture data only, from a [`File`](std::fs::File) for example.
/// * `pic_type` will always be [`PictureType::Other`], be sure to change it accordingly if
/// writing.
///
/// # Errors
///
/// * `reader` contains less than 8 bytes
/// * `reader` does not contain a supported format.
/// See [`MimeType`] for valid formats
/// * `reader` does not contain a supported format. See [`MimeType`] for valid formats
pub fn from_reader<R>(reader: &mut R) -> Result<Self>
where
R: Read,

View file

@ -25,7 +25,7 @@ impl<T> SeekStreamLen for T where T: Seek {}
/// Provides a method to truncate an object to the specified length
///
/// This is one component of the [`FileLike`] trait, which is used to provide implementors access to any
/// file saving methods such as [`crate::file::AudioFile::save_to`].
/// file saving methods such as [`AudioFile::save_to`](crate::file::AudioFile::save_to).
///
/// Take great care in implementing this for downstream types, as Lofty will assume that the
/// container has the new length specified. If this assumption were to be broken, files **will** become corrupted.
@ -114,7 +114,7 @@ where
/// Provides a method to get the length of a storage object
///
/// This is one component of the [`FileLike`] trait, which is used to provide implementors access to any
/// file saving methods such as [`crate::file::AudioFile::save_to`].
/// file saving methods such as [`AudioFile::save_to`](crate::file::AudioFile::save_to).
///
/// Take great care in implementing this for downstream types, as Lofty will assume that the
/// container has the exact length specified. If this assumption were to be broken, files **may** become corrupted.
@ -210,7 +210,7 @@ where
/// Provides a set of methods to read and write to a file-like object
///
/// This is a combination of the [`Read`], [`Write`], [`Seek`], [`Truncate`], and [`Length`] traits.
/// It is used to provide implementors access to any file saving methods such as [`crate::file::AudioFile::save_to`].
/// It is used to provide implementors access to any file saving methods such as [`AudioFile::save_to`](crate::file::AudioFile::save_to).
///
/// Take great care in implementing this for downstream types, as Lofty will assume that the
/// trait implementations are correct. If this assumption were to be broken, files **may** become corrupted.