From 70ab9f3f74987300080f4a60395822d84efce087 Mon Sep 17 00:00:00 2001
From: Ernesto Rico Schmidt <ernesto@helsinki.at>
Date: Wed, 13 Nov 2024 17:18:44 -0400
Subject: [PATCH] docs: update docstrings for create and update methods
---
program/serializers.py | 10 ++++++++--
1 file changed, 8 insertions(+), 2 deletions(-)
diff --git a/program/serializers.py b/program/serializers.py
index 3938ae96..cb943336 100644
--- a/program/serializers.py
+++ b/program/serializers.py
@@ -1511,7 +1511,10 @@ class PlaylistSerializer(serializers.ModelSerializer):
) + read_only_fields
def create(self, validated_data):
- """Create a new Playlist instance, given the validated data."""
+ """Create a new Playlist instance, given the validated data.
+
+ A ValidationError is raised if a playlist entry is invalid or if multiple null duration
+ entries are present."""
user = self.context["request"].user
user_is_owner = user in validated_data.get("show").owners.all()
@@ -1543,7 +1546,10 @@ class PlaylistSerializer(serializers.ModelSerializer):
return playlist
def update(self, instance, validated_data):
- """Update an existing Playlist instance, given the validated data."""
+ """Update an existing Playlist instance, given the validated data.
+
+ A ValidationError is raised if a playlist entry is invalid or if multiple null duration
+ entries are present."""
user = self.context["request"].user
user_is_owner = user in instance.show.owners.all()
--
GitLab