Download as
Browse Code »

Commit 6c215efe2f75ce2135f94a5972369d5f09b67ee4

Authored by Lucas Kanashiro
1 parent 7fe0d78a
Exists in master and in 30 other branches 1.12.x, add_requests_as_dep, celery_service, change-passwd-signal, colab-signals, colab-vcard, colab_search, colab_tag, colab_tag_merge, detach_super_archives, fix-dashboard, fix-message-preview, fix_app_label, fix_header, fixed_gitlab_import, go_to_profile_panel, mobile_user_scalable, paginate-threads, profile_integration, refactor-data-import, remove-gitlab-plugin, removing_namespace, search_block, search_filters, split_screen, startplugin, timestamp_plugins, translation_review, user_regex, validate-passwd

Remove signals.py from plugin dev documentation 

It is no longer necessary implements signals.py in plugins root directory, this
implementation was moved into apps.py

Signed-off-by: Lucas Moura <lucas.moura128@gmail.com>
Showing 1 changed file with 9 additions and 11 deletions   Show diff stats
docs/source/plugindev.rst
  Diff comments   View file @6c215ef
... ... @@ -15,20 +15,18 @@ want to communicate with another plugins.
15 15 In order to configure a plugin to able to listen and send signals using Colab
16 16 signals structure, some steps are required:
17 17  
18   -* You must create signals.py in plugin root directory to implement both,
19   - registered signals and connect signals.
20   -* In the signals.py file it is necessary to declare a list variable containing all the
21   - signals that the plugin will dispatch. It is suggested to name the variable
22   - "registered_signals", but that nomenclature not strictly necessary.
  18 +* In the apps.py file it is necessary to declare a list variable containing all
  19 + the signals that the plugin will dispatch. It is suggested to name the
  20 + variable "registered_signals", but that nomenclature not strictly necessary.
23 21 * It is also necessary to declare a variable containing the name of the plugin
24 22 that will send the signal. It must be said that the name of the plugin cannot
25 23 contain any special character, such as dot or comma. It is suggested to name
26 24 the variable "short_name", but that nomenclature is not strictly
27 25 necessary.
28   -* In order to actually register the signals, it is necessary to implement the method
29   - register_signal, which require the name of the plugin that is registering the
30   - signals and a list of signals to be registered as parameters. You must not
31   - call this method nowhere.
  26 +* In order to actually register the signals, it is necessary to implement the
  27 + method register_signal, which require the name of the plugin that is
  28 + registering the signals and a list of signals to be registered as parameters.
  29 + You must not call this method nowhere.
32 30 * In order to listen for a given signal, it is required to create a handling
33 31 method. This method should be located at a file named tasks.py in the same
34 32 directory as the plugins files. It also must be said that this method need to
... ... @@ -68,8 +66,8 @@ signals structure, some steps are required:
68 66 HANDLING_METHOD)
69 67  
70 68  
71   -* To send a broadcast signal you must call send method anywhere passing signal name
72   - and sender as arguments. If necessary you can pass another parameters in
  69 +* To send a broadcast signal you must call send method anywhere passing signal
  70 + name and sender as arguments. If necessary you can pass another parameters in
73 71 \*\*kwargs. As you can see below:
74 72  
75 73 .. code-block:: python
... ...