From 88c35b7f6f1988ba99dd2d5bf1689d177c05172b Mon Sep 17 00:00:00 2001 From: Douglas Jacobsen Date: Wed, 10 Jan 2024 15:53:18 -0700 Subject: [PATCH] Add reference to python's zip docs --- lib/ramble/docs/workspace_config.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/lib/ramble/docs/workspace_config.rst b/lib/ramble/docs/workspace_config.rst index d2ccccb61..964e61652 100644 --- a/lib/ramble/docs/workspace_config.rst +++ b/lib/ramble/docs/workspace_config.rst @@ -280,6 +280,11 @@ there would be 4 experiments, each defined by a unique Explicit Variable Zips: ^^^^^^^^^^^^^^^^^^^^^^^ +A common pattern in python for iterating over multiple lists in lock-step is to +use something called a zip. For more information on how this behaves in +practice, see +`Python's zip documentation `_. + Ramble's workspace config contains syntax for defining explicit variable zips. These zips are named grouping of variables that are related and should be iterated over together when generating experiments.