From a4cf5860a378517a6787b4febb810d9d5bab4735 Mon Sep 17 00:00:00 2001 From: OMGeeky Date: Wed, 21 Jun 2023 18:30:40 +0200 Subject: [PATCH] add documentation for duration_to_string (with example) and make it public --- src/lib.rs | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/src/lib.rs b/src/lib.rs index 673b5f4..9b0e775 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -829,7 +829,17 @@ fn get_date_string_from_video(video: &VideoData) -> Result { //endregion -fn duration_to_string(duration: &Duration) -> String { +/// Converts a duration to a string that is usable for example in a youtube title +/// +/// Example: +/// +/// ``` +/// use chrono::Duration; +/// let duration: Duration = Duration::seconds(20); +/// let s = downloader::duration_to_string(&duration); +/// assert_eq!(s, "00:00:20"); +/// ``` +pub fn duration_to_string(duration: &Duration) -> String { trace!("duration to string for duration: {:?}", duration); let seconds = duration.num_seconds(); let hours = seconds / 3600;