From 5608b01cf08a68c9dd78d757f13d3d4e6a27a347 Mon Sep 17 00:00:00 2001
From: "eduardo.serna" <eduardo.serna@flaxandteal.co.uk>
Date: Thu, 17 Oct 2024 16:23:45 +0200
Subject: [PATCH] add some comments

---
 create_env_and_build.sh | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/create_env_and_build.sh b/create_env_and_build.sh
index 596269f5..6e36e45c 100644
--- a/create_env_and_build.sh
+++ b/create_env_and_build.sh
@@ -1,5 +1,13 @@
 #!/bin/bash
 
+# The script expects exactly one argument: the name of the conda environment to be created.
+# Usage example:
+# . ./create_env_and_build.sh <env-name>
+
+
+####################################
+# helper functions
+
 # set -x
 set -e
 
@@ -17,6 +25,10 @@ safe_exit() {
     exit 1
 }
 
+
+####################################
+# script logic
+
 if [ $# -ne 1 ]; then
     echo "Usage: $0 <conda-environment-name>"
     safe_exit