Improve doc comment for GlobalConfig

This commit is contained in:
Sasha Koshka 2024-08-23 01:14:08 -04:00
parent 4b29820452
commit 81bd635b09

View File

@ -229,8 +229,9 @@ func ApplicationConfig (app ApplicationDescription) (config.ConfigCloser, error)
}
var currentGlobalConfig config.Config
// GlobalConfig returns the global config. This is managed by Nasin and must not
// be closed by the application.
// GlobalConfig returns the global config. It contains options that apply to
// Tomo/Nasin itself, such as the style sheet and the icon set. This is managed
// by Nasin and must not be closed by the application.
func GlobalConfig () config.Config {
return currentGlobalConfig
}