refactor(folder_analyzer): simplify docstring for file listing method

This commit refactors the docstring of the 'list_all_files_in_dir' method in the FolderAnalyzerGenHook class. The previous detailed documentation was removed to streamline the code and focus on the essential purpose of the method. This change improves code readability and maintainability by reducing verbosity while still providing a brief overview of the method's functionality. The simplification aligns with best practices for documentation, ensuring that it remains concise and relevant without overwhelming the reader with excessive detail.

Author: sumansaurabh

penify_hook/folder_analyzer.py

@@ -12,21 +12,7 @@ def __init__(self, dir_path: str, api_client: APIClient):
         super().__init__(dir_path, api_client)
 
     def list_all_files_in_dir(self, dir_path: str):
-        """List all files in a directory and its subdirectories.
-
-        This function traverses the specified directory and its subdirectories,
-        collecting the full paths of all files found. It ignores any directories
-        that start with a dot (.), which are typically hidden directories in
-        Unix-like operating systems. The resulting list contains the full paths
-        of the files, making it useful for file management tasks.
-
-        Args:
-            dir_path (str): The path to the directory to search for files.
-
-        Returns:
-            list: A list of full file paths found in the specified directory and its
-            subdirectories.
-        """
+        """List all files in a directory and its subdirectories."""
 
         files = []
         for dirpath, dirnames, filenames in os.walk(dir_path):