From dc5435fa6817a3408f481b44b33a1a2776b5f84b Mon Sep 17 00:00:00 2001
From: redxef <redxef@redxef.at>
Date: Sun, 22 Dec 2024 18:44:43 +0100
Subject: [PATCH] docs: update docs to use new global variables.

---
 README.md   | 12 ++++++------
 examples.md |  2 +-
 2 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 8855aee..ba94155 100644
--- a/README.md
+++ b/README.md
@@ -28,7 +28,7 @@ Playlists:
 - PlaylistId: 24f12e1e-3278-d6d6-0ca4-066e93296c95
   UserId: 6eec632a-ff0d-4d09-aad0-bf9e90b14bc6
 Name: Rock
-Program: (begin (invoke item "IsFavoriteOrLiked" (user)))
+Program: (begin (invoke item "IsFavoriteOrLiked" (list *user*)))
 SortProgram: (begin items)
 Filename: /config/data/smartplaylists/Rock.yaml
 Enabled: true
@@ -43,7 +43,7 @@ line and write multiline filters like this:
 ```yaml
 Porgram: |
   (begin
-    (invoke item "IsFavoriteOrLiked" (list user)))
+    (invoke item "IsFavoriteOrLiked" (list *user*)))
 ```
 
 This is equivalent to the above example (not counting the other
@@ -85,7 +85,7 @@ still work and remember the correct playlist.
 
 A lisp program to decide on a per item basis if it should be included in
 the playlist, return `nil` to not include items, return any other value
-to include them. Global variables `user` and `item` are predefined
+to include them. Global variables `*user*` and `*item*` are predefined
 and contain a [User](https://github.com/jellyfin/jellyfin/blob/master/Jellyfin.Data/Entities/User.cs) and
 [BaseItem](https://github.com/jellyfin/jellyfin/blob/master/MediaBrowser.Controller/Entities/BaseItem.cs)
 respectively.
@@ -107,8 +107,8 @@ to: `(is-favourite)`.
 ### SortProgram
 
 This works exactly like [Program](#program), but the input is the
-user and a list of items (`items`) matched by [Program](#program).
-The default is `(begin items)`, which doesn't sort at all. To sort
+user and a list of items (`*items*`) matched by [Program](#program).
+The default is `(begin *items*)`, which doesn't sort at all. To sort
 the items by name you could use the following program:
 
 ```lisp
@@ -118,7 +118,7 @@ the items by name you could use the following program:
     (string>
       (car (getitems a "Name"))
       (car (getitems b "Name"))))
-  items)
+  *items*)
 ```
 
 ### Filename
diff --git a/examples.md b/examples.md
index fce34bb..6abbd21 100644
--- a/examples.md
+++ b/examples.md
@@ -35,7 +35,7 @@
   Program: |
     (let
       (parent
-        (invoke-generic item "FindParent" nil (list "MediaBrowser.Controller.Entities.Audio.MusicArtist, MediaBrowser.Controller")))
+        (invoke-generic *item* "FindParent" nil (list "MediaBrowser.Controller.Entities.Audio.MusicArtist, MediaBrowser.Controller")))
       (cond
         ((null parent) nil)
         (t (string= (car (getitems parent "Name")) "Haller"))))