From de6d8eae758caae78b6d2f1ed48f7dd435517cf4 Mon Sep 17 00:00:00 2001 From: absidue <48293849+absidue@users.noreply.github.com> Date: Mon, 31 Jan 2022 18:00:45 +0100 Subject: [PATCH] Improve documentation for playlist_info (fixes #247) --- play-dl/YouTube/utils/extractor.ts | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/play-dl/YouTube/utils/extractor.ts b/play-dl/YouTube/utils/extractor.ts index 7e7ff46..c2d012b 100644 --- a/play-dl/YouTube/utils/extractor.ts +++ b/play-dl/YouTube/utils/extractor.ts @@ -461,7 +461,10 @@ export async function decipher_info( * ``` * @param url Playlist URL * @param options Playlist Info Options - * - `boolean` incomplete : If set to true, parses playlist with hidden videos. + * - `boolean` incomplete : When this is set to `false` (default) this function will throw an error + * if the playlist contains hidden videos. + * If it is set to `true`, it parses the playlist skipping the hidden videos, + * only visible videos are included in the resulting {@link YouTubePlaylist}. * * @returns YouTube Playlist */