From 172e685629a28cd00710bc78b8e9e0b58d4b9126 Mon Sep 17 00:00:00 2001 From: YozoraXCII <96386153+YozoraXCII@users.noreply.github.com> Date: Wed, 10 Jan 2024 15:26:11 +0000 Subject: [PATCH] fix bad example of `reset_overlays` and amend incorrect statements on what some template variables do. --- CHANGELOG | 1 + docs/defaults/collections.md | 2 +- docs/defaults/guide.md | 4 +++- docs/pmm/faqs.md | 3 ++- 4 files changed, 7 insertions(+), 3 deletions(-) diff --git a/CHANGELOG b/CHANGELOG index 2c6d99f9..4f488e0e 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -9,6 +9,7 @@ Updated lxml requirement to 5.1.0 # Bug Fixes Fixed the Rate Limit on MDbList calls +- Users who do not have VIP status on MDBList will be limited to 1 request per second. Users with VIP status are limited to 5 requests per second Fixed collection fields being locked during batch edits when they shouldn't be. Various other Minor Fixes diff --git a/docs/defaults/collections.md b/docs/defaults/collections.md index 816d7b1b..a1747dcc 100644 --- a/docs/defaults/collections.md +++ b/docs/defaults/collections.md @@ -112,7 +112,7 @@ This is the default PMM collection ordering: Configs can be customized using the `template_variables` attribute when calling the file. These `template_variables` will be given to every template call in the file which allows them to affect how that file runs. -This example changes the ratings overlay to work on episodes. +This example disables two keys, which will prevent those collections from being created. It also sets the visibility of one of the keys so that it is visible on the library tab, the server owner's homescreen and shared user's homescreens (assuming they server owner and/or the shared users have the library pinned to their homescreen) ```yaml libraries: diff --git a/docs/defaults/guide.md b/docs/defaults/guide.md index 530f106f..a49642fc 100644 --- a/docs/defaults/guide.md +++ b/docs/defaults/guide.md @@ -39,7 +39,9 @@ libraries: Configs can be customized using the `template_variables` attribute when calling the file. These `template_variables` will be given to every template call in the file which allows them to affect how that file runs. -This example changes the ratings overlay to work on episodes. +For collections, this example disables two keys, which will prevent those collections from being created. It also sets the visibility of one of the keys so that it is visible on the library tab, the server owner's homescreen and shared user's homescreens (assuming they server owner and/or the shared users have the library pinned to their homescreen) + +For overlays, this example changes the ratings overlay to apply to episodes rather than shows. ```yaml libraries: diff --git a/docs/pmm/faqs.md b/docs/pmm/faqs.md index 0bcfa09e..f1e04806 100644 --- a/docs/pmm/faqs.md +++ b/docs/pmm/faqs.md @@ -447,13 +447,14 @@ With the release of PMM 1.20, several changes have taken place that we would lik Movies: remove_overlays: false reapply_overlays: false #(1)! - reset_overlays: false + # reset_overlays: plex #(2)! schedule_overlays: daily overlay_files: - pmm: audio_codec ``` 1. We strongly advise never setting this to `true` as it can cause [Image Bloat](scripts/image-cleanup.md) + 2. This is purely an example, you do not need to specify `reset_overlays` or any of these attributes unless you specifically need to use them. ??? blank "`imdb_list` no longer works for Title or Keyword search URLs (click to expand).ΒΆ"