From 4341401a09a1055f5e5a86b8f80fe36494f93b4d Mon Sep 17 00:00:00 2001
From: ppinchuk <ppinchuk@nrel.gov>
Date: Tue, 20 Feb 2024 14:48:55 -0700
Subject: [PATCH] Clarify memory docstring

---
 gaps/cli/documentation.py | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/gaps/cli/documentation.py b/gaps/cli/documentation.py
index 0d9a2e89..982ce7b2 100644
--- a/gaps/cli/documentation.py
+++ b/gaps/cli/documentation.py
@@ -311,7 +311,10 @@
             cost. By default, ``"normal"``.
         :memory: (int, optional)
             Node memory request in GB. By default, ``None``, which
-            does not specify a memory limit.{n}{eep}
+            uses the scheduler's default memory limit. Note that this
+            can be quite small (SLURM's default is a couple GB of
+            RAM), so you may run into out-of-memory (OOM) issues
+            if you leave this argument unspecified.{n}{eep}
         :queue: (str, optional; PBS ONLY)
             HPC queue to submit job to. Examples include: 'debug',
             'short', 'batch', 'batch-h', 'long', etc.