From dd69802e4715fcfce89bf36364ae18791dfaafb6 Mon Sep 17 00:00:00 2001
From: Niket <15953349+niketagrawal@users.noreply.github.com>
Date: Mon, 30 Sep 2024 14:03:25 +0200
Subject: [PATCH] add comments for preserving environment_readthedocs yml file

---
 .readthedocs.yml | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/.readthedocs.yml b/.readthedocs.yml
index 88c6531f..c70eddda 100644
--- a/.readthedocs.yml
+++ b/.readthedocs.yml
@@ -32,11 +32,11 @@ build:
       # directory with the docs/ directory of the latest tag.
 
 # The pre-install step does the following:
-# Download and unzip the latest tag.
-# Move the current environment_readthedocs.yaml file to a temporary location.
-# Remove the current docs/ folder.
-# Move the docs/ folder from the latest tag to the current location.
-# Move the environment_readthedocs.yaml file back to the docs/ folder.
+# 1. Download and unzip the latest tag.
+# 2. Move the current environment_readthedocs.yaml file to a temporary location. (Preserving the current environment_readthedocs.yaml facilitates introducing changes to the environment_readthedocs.yaml and testing them on the latest tag.)
+# 3. Remove the current docs/ folder.
+# 4. Move the docs/ folder from the latest tag to the current location.
+# 5. Move the environment_readthedocs.yaml file back to the docs/ folder.
 
 conda:
   environment: docs/environment_readthedocs.yaml