Clarify memory docstring

NREL · Feb 20, 2024 · 4341401 · 4341401
1 parent c42d166
commit 4341401
Showing 1 changed file with 4 additions and 1 deletion.
diff --git 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.