Skip to content

Commit

Permalink
Fix unlinked docs warning
Browse files Browse the repository at this point in the history
  • Loading branch information
VixieTSQ committed May 21, 2024
1 parent dc0ee66 commit 2e835a0
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 7 deletions.
4 changes: 4 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,7 @@ rstest = "0.19.0"

[features]
steering-manifest = ["dep:serde", "dep:serde_json"]

[package.metadata.docs.rs]
all-features = true
rustdoc-args = ["--cfg", "docsrs"]
6 changes: 4 additions & 2 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,14 @@
clippy::too_many_lines,
clippy::cognitive_complexity
)]
#![cfg_attr(docsrs, feature(doc_cfg))]

use std::{collections::HashMap, io, num::NonZeroU8};

pub mod playlist;
pub mod tags;

#[cfg_attr(docsrs, doc(cfg(feature = "steering-manifest")))]
#[cfg(feature = "steering-manifest")]
pub mod steering_manifest;

Expand Down Expand Up @@ -279,10 +281,10 @@ pub enum KeyFormat {
Other(String),
}

/// Identifies a [`crate::steering_manifest::SteeringManifest`].
/// Identifies a [`steering_manifest::SteeringManifest`].
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ContentSteering {
/// The URI identifying the [`crate::steering_manifest::SteeringManifest`].
/// The URI identifying the [`steering_manifest::SteeringManifest`].
pub server_uri: String,
pub pathway_id: Option<String>,
}
Expand Down
6 changes: 3 additions & 3 deletions src/playlist.rs
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ pub struct AudioRendition {
pub channels: Option<crate::AudioChannelInformation>,

/// Information about this rendition.
info: RenditionInfo,
pub info: RenditionInfo,

/// The URI that identifies the Media Playlist file.
pub uri: Option<String>,
Expand Down Expand Up @@ -244,8 +244,8 @@ pub struct MediaPlaylist {
/// True if no more Media Segments will be added to the Media Playlist file.
pub finished: bool,

/// Whether or not the playlist is for a live mutable stream, or a
/// static immutable stream. `Vod` playlists cannot change.
/// Whether or not the playlist is for a mutable append-only stream, or a
/// static immutable stream.
pub playlist_type: Option<crate::PlaylistType>,

/// If Some, indicates the server-recommended minimum distance from
Expand Down
3 changes: 1 addition & 2 deletions src/tags/serialize.rs
Original file line number Diff line number Diff line change
Expand Up @@ -753,12 +753,11 @@ impl Tag {

#[cfg(test)]
mod tests {
use std::{collections::HashMap, time::Duration};

use rstest::*;

use crate::{
tags::MediaType, AttributeValue, ContentProtectionConfiguration, EncryptionMethod,
tags::MediaType, ContentProtectionConfiguration, EncryptionMethod,
RenditionPlaybackPriority, SupplementalCodec, VideoChannelSpecifier,
};

Expand Down

0 comments on commit 2e835a0

Please sign in to comment.