CORE-2011 Add docs to DE jobs filter-request-max-requirements

Added some docs to apps.service.apps.de.jobs.common/filter-request-max-requirements
cyverse-de · Oct 15, 2024 · 2f65330 · 2f65330
1 parent 082c587
commit 2f65330
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/apps/service/apps/de/jobs/common.clj b/src/apps/service/apps/de/jobs/common.clj
@@ -64,6 +64,9 @@
                           :max_cpu_cores]))
 
 (defn- filter-request-max-requirements
+  "Ensure max requirement requests from the client are at least 0,
+  so that any max set by a tool is not automatically requested,
+  then the job services can choose a reasonable default instead."
   [requirements]
   {:memory_limit  (get requirements :memory_limit 0)
    :max_cpu_cores (get requirements :max_cpu_cores 0)})