_configuration_details_

From Yombo
< docs‎ | hooks
Jump to: navigation, search
configuration_details
Hook name _configuration_details_
Status Active
Hook source type Library
Stop on exception No
Commonly used No
Implemented by configuration

Summary

Provide a description for a configuration variable and is i18n friendly.

Details

Provide a reference description for a configuration variable. In this example, information is provided for configuration section 'webinterface' and options enabled and port.

def _configuration_details_(self, **kwargs):
   return [{'webinterface': {
               'enabled': {
                   'description': {
                       'en': 'Enables/disables the web interface.',
                   }
               },
               'port': {
                   'description': {
                       'en': 'Port number for the web interface to listen on.'
                   }
               }
           },
   }]

KWargs

No arguments are sent.

Expects

Expects a dictionary. See example above for details.


This page was last edited on 15 September 2018.