Add comments

pkg/config/app_config.go

@@ -232,16 +232,20 @@ func (c *AppConfig) GetTempDir() string {
 	return c.TempDir
 }
 
+// findConfigFile looks for a possibly existing config file.
+// This function does NOT create any folders or files.
 func findConfigFile(filename string) (exists bool, path string) {
 	if envConfigDir := os.Getenv("CONFIG_DIR"); envConfigDir != "" {
 		return true, filepath.Join(envConfigDir, filename)
 	}
 
+	// look for jesseduffield/lazygit/filename in XDG_CONFIG_HOME and XDG_CONFIG_DIRS
 	legacyConfigPath, err := xdg.SearchConfigFile(filepath.Join("jesseduffield", "lazygit", filename))
 	if err == nil {
 		return true, legacyConfigPath
 	}
 
+	// look for lazygit/filename in XDG_CONFIG_HOME and XDG_CONFIG_DIRS
 	configFilepath, err := xdg.SearchConfigFile(filepath.Join("lazygit", filename))
 	if err == nil {
 		return true, configFilepath
@@ -252,7 +256,10 @@ func findConfigFile(filename string) (exists bool, path string) {
 
 var ConfigFilename = "config.yml"
 
+// stateFilePath looks for a possibly existing state file.
+// if none exist, the default path is returned and all parent directories are created.
 func stateFilePath(filename string) (string, error) {
+	// looks for XDG_STATE_HOME/lazygit/filename
 	stateFile, err := xdg.SearchStateFile(filepath.Join("lazygit", filename))
 	if err == nil {
 		return stateFile, nil