Update contributor documentation regarding file naming conventions

automl · Jan 17, 2024 · bcab63f · bcab63f
1 parent b0d834c
commit bcab63f
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/docs/contributing/filenamings.md b/docs/contributing/filenamings.md
@@ -12,7 +12,7 @@ In our design, we have adopted a naming convention for variables, which includes
 
 As an illustration:
 
-- `root_directory_results` (str): Represents the name of the result directory located in the root directory.
-- `root_file_locker` (str): Represents the name of the locker file located in the root directory.
+- `ROOT_DIRECTORY_RESULTS` (str): Represents the name of the result directory located in the root directory.
+- `ROOT_FILE_LOCKER` (str): Represents the name of the locker file located in the root directory.
 
 This structured approach enhances the clarity of file naming and facilitates seamless updates for contributors across different sections of the codebase.
diff --git a/neps/metahyper/run_file_names.py b/neps/metahyper/run_file_names.py
@@ -14,12 +14,12 @@ class Filenamings:
     associated file or directory.
 
     General:
-    - location_type_purpose
+    - LOCATION_TYPE_PURPOSE
 
     Example:
-    - root_directory_results (str): Represents the name of the result directory
+    - ROOT_DIRECTORY_RESULTS (str): Represents the name of the result directory
         located in the root directory.
-    - root_file_locker (str): Represents the name of the locker file located in
+    - ROOT_FILE_LOCKER (str): Represents the name of the locker file located in
         the root directory.
     """