Improved docs

This commit is contained in:
Kieran Eglin
2024-04-03 17:30:13 -07:00
parent e55bcaddd0
commit 332485cdaf
+3 -4
View File
@@ -39,10 +39,9 @@ defmodule Pinchflat.Media do
@doc """ @doc """
Returns a list of pending media_items for a given source, where Returns a list of pending media_items for a given source, where
pending means the `media_filepath` is `nil` AND the media_item pending means the `media_filepath` is `nil` AND the media_item
matches the format selection rules of the parent media_profile. matches satisfies `MediaQuery.with_media_pending_download`. You
should really check out that function if you need to know more
See `where_pending` but tl;dr is it _may_ filter based because it has a lot going on.
on shorts livestreams depending on the media_profile settings.
Returns [%MediaItem{}, ...]. Returns [%MediaItem{}, ...].
""" """