diff --git a/docs/source/plugindev.rst b/docs/source/plugindev.rst index 079464d..438c792 100644 --- a/docs/source/plugindev.rst +++ b/docs/source/plugindev.rst @@ -23,6 +23,8 @@ signals structure, some steps are required: contain any special character, such as dot or comma. It is suggested to name the variable "short_name", but that nomenclature is not strictly necessary. +* Finally, the variable namespace should also be defined. This variable is the + url namespace for django reverse. * In order to actually register the signals, it is necessary to implement the method register_signal, which require the name of the plugin that is registering the signals and a list of signals to be registered as parameters. @@ -57,6 +59,7 @@ signals structure, some steps are required: class PluginApps(ColabPluginAppConfig): short_name = PLUGIN_NAME signals_list = [SIGNAL1, SIGNAL2] + namespace = PLUGIN_NAMESPACE def registered_signal(self): register_signal(self.short_name, self.signals_list) diff --git a/docs/source/user.rst b/docs/source/user.rst index 34d5813..2d2e10f 100644 --- a/docs/source/user.rst +++ b/docs/source/user.rst @@ -118,7 +118,6 @@ Use this template for the plugin configuration file urls = { 'include': '[plugin_module_path].urls', - 'namespace': '[plugin_name]', 'prefix': '[application_prefix]/', # Exemple: http://site.com/[application_prefix]/ } @@ -177,9 +176,6 @@ urls Declares the prefix for the url. - Atention: Any URL used in the plugins' settings should not be preceded by "/" -.. attribute:: namespace - - Declares the namespace for the url. menu ++++ -- libgit2 0.21.2