From 3edeb9763a97b89e20cc512cff2c1bf7bf670f47 Mon Sep 17 00:00:00 2001
From: Dave Smith-Hayes <me@davesmithhayes.com>
Date: Thu, 14 Nov 2024 02:07:29 +0000
Subject: [PATCH] Add some documenation

---
 .../Repository/Episode/EpisodeFileRepositoryInterface.php    | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/app/src/Domain/Repository/Episode/EpisodeFileRepositoryInterface.php b/app/src/Domain/Repository/Episode/EpisodeFileRepositoryInterface.php
index 7838747..0853d27 100644
--- a/app/src/Domain/Repository/Episode/EpisodeFileRepositoryInterface.php
+++ b/app/src/Domain/Repository/Episode/EpisodeFileRepositoryInterface.php
@@ -6,6 +6,11 @@ use Slovocast\Domain\Entity\Episode;
 use Slovocast\Domain\Entity\Episode\File;
 use Slovocast\Domain\RepositoryInterface;
 
+/**
+ * The Episode File repository should consist of getting and setting the data
+ * about the file stored in the database. The implementation of this class
+ * should concern itself with the data _about_ the file, not the file itself.
+ */
 interface EpisodeFileRepositoryInterface extends RepositoryInterface
 {
     public function get(string $location): File;