From 6800adfaa46f35bdd7fae379bd8e95a00551be3b Mon Sep 17 00:00:00 2001 From: Andrey Antukh Date: Thu, 19 Nov 2020 17:28:32 +0100 Subject: [PATCH] :books: Add some documentation comments to some tasks. --- backend/src/app/tasks/maintenance.clj | 3 +++ backend/src/app/tasks/remove_media.clj | 4 ++++ 2 files changed, 7 insertions(+) diff --git a/backend/src/app/tasks/maintenance.clj b/backend/src/app/tasks/maintenance.clj index c8a622021..be344a5e9 100644 --- a/backend/src/app/tasks/maintenance.clj +++ b/backend/src/app/tasks/maintenance.clj @@ -22,6 +22,9 @@ ;; Task: Delete Executed Tasks ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; +;; This tasks perform a cleanup of already executed tasks from the +;; database. + (s/def ::max-age ::dt/duration) (s/def ::delete-completed-tasks (s/keys :req-un [::max-age])) diff --git a/backend/src/app/tasks/remove_media.clj b/backend/src/app/tasks/remove_media.clj index f6d39df4a..e4020e081 100644 --- a/backend/src/app/tasks/remove_media.clj +++ b/backend/src/app/tasks/remove_media.clj @@ -22,6 +22,10 @@ ;; Task: Remove Media ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; +;; Task responsible of explicit action of removing a media from file +;; system. Mainly used for profile photo change; when we really know +;; that the previous photo becomes unused. + (s/def ::path ::us/not-empty-string) (s/def ::props (s/keys :req-un [::path]))