feat: add comment why we should use replace in value configuration

lean/models/json_module.py

@@ -137,6 +137,13 @@ def get_settings(self) -> Dict[str, str]:
                 for key, value in configuration._value.items():
                     settings[key] = str(value)
             else:
+                # Replace escaped newline characters and backslashes in the configuration value.
+                # When reading the JSON configuration through Python, newline characters ('\n') and backslashes ('\')
+                # may be escaped, causing issues in scenarios where these characters are expected to be interpreted
+                # literally (e.g., file paths, multi-line strings). This replace operation ensures that:
+                # 1. Escaped newline characters ('\\n') are correctly interpreted as actual newlines ('\n').
+                # 2. Backslashes ('\\') in file paths are converted to forward slashes ('/'), making paths
+                #    more consistent across different operating systems.
                 settings[configuration._id] = str(configuration._value).replace("\\n", "\n").replace("\\", "/")
 
         return settings