Skip to content

Commit a4f6d74

Browse files
committed
Fix: Update plugin file naming convention for DataLab migration guide
1 parent ca41ae8 commit a4f6d74

File tree

2 files changed

+48
-0
lines changed

2 files changed

+48
-0
lines changed

doc/features/advanced/migration_v020_to_v100.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,27 @@ The DataLab package was renamed from ``cdl`` to ``datalab`` for clarity:
6868
import sigima.params
6969
from datalab.plugins import PluginBase
7070
71+
Plugin file naming convention
72+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
73+
74+
Plugin filenames must follow the new naming convention:
75+
76+
.. important::
77+
78+
Plugin files must be renamed from ``cdl_*.py`` to ``datalab_*.py``.
79+
80+
**Examples:**
81+
82+
- ``cdl_myplugin.py`` → ``datalab_myplugin.py``
83+
- ``cdl_custom_filters.py`` → ``datalab_custom_filters.py``
84+
- ``cdl_example.py`` → ``datalab_example.py``
85+
86+
This naming convention is required for DataLab to automatically discover and load plugins at startup. Plugins that don't follow this naming pattern will not be loaded.
87+
88+
.. note::
89+
90+
The plugin discovery mechanism looks for Python files matching the pattern ``datalab_*.py`` in the plugins directory. Make sure to update your plugin filenames accordingly.
91+
7192
New result objects
7293
^^^^^^^^^^^^^^^^^^
7394

doc/locale/fr/LC_MESSAGES/features/advanced/migration_v020_to_v100.po

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,33 @@ msgstr "Renommage du package"
102102
msgid "The DataLab package was renamed from ``cdl`` to ``datalab`` for clarity:"
103103
msgstr "Le package DataLab a été renommé de ``cdl`` à ``datalab`` par souci de clarté :"
104104

105+
msgid "Plugin file naming convention"
106+
msgstr "Convention de nommage des fichiers de plugin"
107+
108+
msgid "Plugin filenames must follow the new naming convention:"
109+
msgstr "Les noms de fichiers de plugin doivent suivre la nouvelle convention de nommage :"
110+
111+
msgid "Plugin files must be renamed from ``cdl_*.py`` to ``datalab_*.py``."
112+
msgstr "Les fichiers de plugin doivent être renommés de ``cdl_*.py`` en ``datalab_*.py``."
113+
114+
msgid "**Examples:**"
115+
msgstr "**Exemples :**"
116+
117+
msgid "``cdl_myplugin.py`` → ``datalab_myplugin.py``"
118+
msgstr "``cdl_myplugin.py`` → ``datalab_myplugin.py``"
119+
120+
msgid "``cdl_custom_filters.py`` → ``datalab_custom_filters.py``"
121+
msgstr "``cdl_custom_filters.py`` → ``datalab_custom_filters.py``"
122+
123+
msgid "``cdl_example.py`` → ``datalab_example.py``"
124+
msgstr "``cdl_example.py`` → ``datalab_example.py``"
125+
126+
msgid "This naming convention is required for DataLab to automatically discover and load plugins at startup. Plugins that don't follow this naming pattern will not be loaded."
127+
msgstr "Cette convention de nommage est requise pour que DataLab découvre et charge automatiquement les plugins au démarrage. Les plugins qui ne suivent pas ce schéma de nommage ne seront pas chargés."
128+
129+
msgid "The plugin discovery mechanism looks for Python files matching the pattern ``datalab_*.py`` in the plugins directory. Make sure to update your plugin filenames accordingly."
130+
msgstr "Le mécanisme de découverte des plugins recherche les fichiers Python correspondant au motif ``datalab_*.py`` dans le répertoire des plugins. Assurez-vous de mettre à jour les noms de fichiers de vos plugins en conséquence."
131+
105132
msgid "New result objects"
106133
msgstr "Nouveaux objets résultat"
107134

0 commit comments

Comments
 (0)