mirrors/hls_m3u8
1
0
Fork 0
mirror of https://github.com/sile/hls_m3u8.git synced 2024-11-25 16:41:00 +00:00
Code Issues Projects Releases Wiki Activity

improve documentation for ProtocolVersion

Browse source
This commit is contained in:
Luro02 2020-02-24 12:41:30 +01:00
parent 49c5b5334c
commit cdb6367dbd
No known key found for this signature in database
GPG key ID: B66FD4F74501A9CF
1 changed files with 3 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
src/types/protocol_version.rs
View file

@ -3,13 +3,8 @@ use std::str::FromStr;
use crate::Error;
/// # [7. Protocol Version Compatibility]
///
/// The [`ProtocolVersion`] specifies, which m3u8 revision is required, to parse
/// a certain tag correctly.
///
/// [7. Protocol Version Compatibility]:
/// https://tools.ietf.org/html/draft-pantos-hls-rfc8216bis-05#section-7
/// The [`ProtocolVersion`] specifies which `m3u8` revision is required, to
/// parse a certain tag correctly.
#[non_exhaustive]
#[allow(missing_docs)]
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
@ -24,7 +19,7 @@ pub enum ProtocolVersion {
}
impl ProtocolVersion {
/// Returns the newest [`ProtocolVersion`], that is supported by
/// Returns the latest [`ProtocolVersion`] that is supported by
/// this library.
///
/// # Example