clarify description of music_saved_tracks and music_liked_tracks

This commit is contained in:
ThetaDev 2024-12-26 01:25:05 +01:00
parent 14e399594f
commit 65ada37214
No known key found for this signature in database
GPG key ID: E319D3C5148D65B6
2 changed files with 6 additions and 1 deletions

View file

@ -68,6 +68,8 @@ impl RustyPipeQuery {
/// Get a list of YouTube Music tracks which the current user has added to their collection /// Get a list of YouTube Music tracks which the current user has added to their collection
/// ///
/// Contains both liked tracks and tracks from saved albums.
///
/// Requires authentication cookies. /// Requires authentication cookies.
#[tracing::instrument(skip(self), level = "error")] #[tracing::instrument(skip(self), level = "error")]
pub async fn music_saved_tracks(&self) -> Result<Paginator<TrackItem>, Error> { pub async fn music_saved_tracks(&self) -> Result<Paginator<TrackItem>, Error> {

View file

@ -123,7 +123,10 @@ impl RustyPipeQuery {
Ok(album) Ok(album)
} }
/// Get all liked tracks of the logged-in user /// Get all liked YouTube Music tracks of the logged-in user
///
/// The difference to [`RustyPipeQuery::music_saved_tracks`] is that this function only returns
/// tracks that were explicitly liked by the user.
/// ///
/// Requires authentication cookies. /// Requires authentication cookies.
pub async fn music_liked_tracks(&self) -> Result<MusicPlaylist, Error> { pub async fn music_liked_tracks(&self) -> Result<MusicPlaylist, Error> {