improve api comment for ListLanguages

This commit is contained in:
cblgh 2021-04-15 20:31:16 +02:00
parent 682283374d
commit 534bdfcb6d

View File

@ -157,9 +157,9 @@ func listLanguages(bundle *i18n.Bundle) map[string]string {
return langmap return langmap
} }
// ListLanguages returns a mapping between the room's translated languages. // ListLanguages returns a map of the room's translated languages.
// The keys are language tags (as strings) and the values are the name of the language tag, as translated in the original language. // The map's keys are language tags (as strings) and the corresponding value is the translated language name.
// For example: en -> English, sv -> Svenska, de -> Deutsch // Example: en -> English, sv -> Svenska, de -> Deutsch
func (h Helper) ListLanguages() map[string]string { func (h Helper) ListLanguages() map[string]string {
return h.languages return h.languages
} }