Quellcode durchsuchen

Updated comments for lodel.plugin.plugins

fixes #205
Yann Weber vor 8 Jahren
Ursprung
Commit
aa1c0fb40c
1 geänderte Dateien mit 12 neuen und 0 gelöschten Zeilen
  1. 12
    0
      lodel/plugin/plugins.py

+ 12
- 0
lodel/plugin/plugins.py Datei anzeigen

@@ -25,6 +25,16 @@ LodelContext.expose_modules(globals(), {
25 25
 # - {{__init__.py}}} containing informations like full_name, authors, licence etc.
26 26
 # - main.py containing hooks registration etc
27 27
 # - confspec.py containing a configuration specification dictionary named CONFSPEC
28
+#
29
+# All plugins are expected to be found in multiple locations :
30
+# - in the lodel package (lodel.plugins)
31
+# - in the context directorie in a plugins/ dir (symlink to lodel.plugins) <-
32
+#this is obsolete now, since we enforce ALL plugins to be in the lodel package
33
+#
34
+#@todo Check if the symlink in the lodelcontext dir is obsolete !!!
35
+#@warning The plugins dir is at two locations : in lodel package and in
36
+#instance directory. Some stuff seems to still needs plugins to be in 
37
+#the instance directory but it seems to be a really bad idea...
28 38
 
29 39
 ##@defgroup plugin_init_specs Plugins __init__.py specifications
30 40
 #@ingroup lodel2_plugins
@@ -622,8 +632,10 @@ name differ from the one found in plugin's init file"
622 632
     #This module name is the "virtual" module where we imported the plugin.
623 633
     #
624 634
     #Typically composed like VIRTUAL_PACKAGE_NAME.PLUGIN_NAME
635
+    #@warning Brokes subdire feature
625 636
     #@param plugin_name str : a plugin name
626 637
     #@return a string representing a module name
638
+    #@todo fix broken subdir capabilitie ( @see module_name() )
627 639
     #@todo check if used, else delete it
628 640
     @classmethod
629 641
     def plugin_module_name(cls, plugin_name):

Laden…
Abbrechen
Speichern