refactor(folder_analyzer): simplify run method docstring

Removed detailed docstring from the 'run' method in the FolderAnalyzerGenHook class to streamline the code. The previous docstring provided extensive information about the file processing logic, which may be considered excessive for a method that is already self-explanatory. This change enhances code readability and maintainability by reducing clutter while retaining the essential purpose of the method. The functionality remains unchanged, ensuring that the post-commit hook continues to process files as intended.

Author: sumansaurabh

penify_hook/folder_analyzer.py

@@ -24,21 +24,7 @@ def list_all_files_in_dir(self, dir_path: str):
         return files
 
     def run(self):
-        """Run the post-commit hook.
-
-        This method processes all files in the specified directory by listing
-        them and running a file analyzer on each one. It provides feedback on
-        the number of files being processed and handles any errors that occur
-        during the analysis of individual files, ensuring that the progress bar
-        updates appropriately even in the event of an error.  It first retrieves
-        a list of all files in the specified directory and prints the total
-        number of files to be processed. Then, it initializes a progress bar to
-        visually indicate the processing status. For each file, it attempts to
-        create an instance of `FileAnalyzerGenHook` and run its analysis method.
-        If an error occurs while processing a file, it catches the exception,
-        prints an error message, and continues with the next file, ensuring that
-        the progress bar reflects the ongoing processing.
-        """
+        """Run the post-commit hook."""
         try:
             file_list = self.list_all_files_in_dir(self.dir_path)
             total_files = len(file_list)