From db894fea7c85cea221fef37f13336eff8dc83b2d Mon Sep 17 00:00:00 2001
From: smokestacklightnin
 <125844868+smokestacklightnin@users.noreply.github.com>
Date: Wed, 18 Dec 2024 19:30:09 -0800
Subject: [PATCH] Add comment to docstring of `_rm_rf_stages`

---
 src/_nebari/upgrade.py | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/_nebari/upgrade.py b/src/_nebari/upgrade.py
index 932e8f45d..51629f02b 100644
--- a/src/_nebari/upgrade.py
+++ b/src/_nebari/upgrade.py
@@ -226,6 +226,10 @@ def _rm_rf_stages(cls, config_filename, dry_run: bool = False, verbose=False):
         """
         Remove stage files during and upgrade step
 
+
+        Usually used when you need files in your `stages` directory to be
+        removed in order to avoid resource conflicts
+
         Args:
             config_filename (str): The path to the configuration file.
         Returns: