add comments

Add comment explaining that the prompt_filename variable should be the same in the post-gen-hook and in the ProjectGenUtils file

Author: varun646

src/PythonProjectBootstrapper/ProjectGenerationUtils.py

@@ -27,7 +27,9 @@
 import shutil  # pylint: disable=unused-import, wrong-import-order
 import textwrap  # pylint: disable=unused-import, wrong-import-order
 
-# TODO: find a way to verify this is the filename the post-gen-hook writes to
+# This filename should be the same as the filename defined in package/hooks/post_gen_project.py
+# Ideally we would be able to assert that these two variables have the same filename, but we encounter errors when importing
+# the variable due to how cookiecutter changes the working directory for the post-gen hook
 prompt_filename: str = "prompt_text.yml"
 
 

src/PythonProjectBootstrapper/package/hooks/post_gen_project.py

@@ -13,6 +13,9 @@
 
 from dbrownell_Common import PathEx
 
+# This filename should be the same as the filename defined in ../../ProjectGenerationUtils.py
+# Ideally we would be able to assert that these two variables have the same filename, but we encounter errors when importing
+# the variable due to how cookiecutter changes the working directory for the post-gen hook
 prompt_filename = "prompt_text.yml"