diff --git a/config/site_settings.yml b/config/site_settings.yml index 6e82e7d14..01336b31c 100644 --- a/config/site_settings.yml +++ b/config/site_settings.yml @@ -1,14 +1,18 @@ # Available options: # -# default - The default value of the setting. -# client - Set to true if the javascript should have access to this setting's value. -# refresh - Set to true if clients should refresh when the setting is changed. -# min - For a string setting, the minimum length. For an integer setting, the minimum value. -# max - For a string setting, the maximum length. For an integer setting, the maximum value. -# regex - A regex that the value must match. -# validator - The name of the class that will be use to validate the value of the setting. -# enum - The setting has a fixed set of allowed values, and only one can be chosen. -# Set to the class name that defines the set. +# default - The default value of the setting. +# client - Set to true if the javascript should have access to this setting's value. +# refresh - Set to true if clients should refresh when the setting is changed. +# min - For a string setting, the minimum length. For an integer setting, the minimum value. +# max - For a string setting, the maximum length. For an integer setting, the maximum value. +# regex - A regex that the value must match. +# validator - The name of the class that will be use to validate the value of the setting. +# enum - The setting has a fixed set of allowed values, and only one can be chosen. +# Set to the class name that defines the set. +# shadowed_by_global - "Shadow" a site setting with a GlobalSetting. If the GlobalSetting +# exists it will be used instead of the setting and the setting will be hidden. +# Useful for things like API keys on multisite. +# # type: email - Must be a valid email address. # type: username - Must match the username of an existing user. # type: list - A list of values, chosen from a set of valid values defined in the choices option. diff --git a/lib/site_setting_extension.rb b/lib/site_setting_extension.rb index 35ba85932..e6c501d9c 100644 --- a/lib/site_setting_extension.rb +++ b/lib/site_setting_extension.rb @@ -117,9 +117,6 @@ module SiteSettingExtension hidden_settings << name end - # You can "shadow" a site setting with a GlobalSetting. If the GlobalSetting - # exists it will be used instead of the setting and the setting will be hidden. - # Useful for things like API keys on multisite. if opts[:shadowed_by_global] && GlobalSetting.respond_to?(name) val = GlobalSetting.send(name) unless val.nil? || (val == ''.freeze)