Improve doc comments for ApplicationSystem*Dirs

This commit is contained in:
Sasha Koshka 2024-08-23 02:27:49 -04:00
parent 27678b36b9
commit 8c647d118d

11
path.go
View File

@ -11,8 +11,9 @@ func ApplicationUserDataDir (app ApplicationDescription) (string, error) {
} }
// ApplicationSystemDataDirs returns a list of directory paths where an // ApplicationSystemDataDirs returns a list of directory paths where an
// application can look for its system-level data files. These directories may // application can look for its system-level data files. Directories returned
// or may not exist. This function may return an empty slice on some platforms. // by this function may or may not actually exist. This function may return an
// empty slice on some platforms.
func ApplicationSystemDataDirs (app ApplicationDescription) ([]string, error) { func ApplicationSystemDataDirs (app ApplicationDescription) ([]string, error) {
return systemDirs(app.ID, systemDataDirs) return systemDirs(app.ID, systemDataDirs)
} }
@ -24,9 +25,9 @@ func ApplicationUserConfigDir (app ApplicationDescription) (string, error) {
} }
// ApplicationSystemDataDirs returns a list of directory paths where an // ApplicationSystemDataDirs returns a list of directory paths where an
// application can look for its system-level configuration files. These // application can look for its system-level configuration files. Directories
// directories may or may not exist. This function may return an empty slice on // returned by this function may or may not actually exist. This function may
// some platforms. // return an empty slice on some platforms.
func ApplicationSystemConfigDirs (app ApplicationDescription) ([]string, error) { func ApplicationSystemConfigDirs (app ApplicationDescription) ([]string, error) {
return systemDirs(app.ID, systemConfigDirs) return systemDirs(app.ID, systemConfigDirs)
} }