#16971: Improve example in documentation

netbox-community · Nov 26, 2024 · 64e56cd · 64e56cd
1 parent a24576f
commit 64e56cd
Showing 1 changed file with 8 additions and 5 deletions.
diff --git a/docs/plugins/development/background-jobs.md b/docs/plugins/development/background-jobs.md
@@ -87,14 +87,17 @@ class MyHousekeepingJob(JobRunner):
 
     def run(self, *args, **kwargs):
         MyModel.objects.filter(foo='bar').delete()
-
-system_jobs = (
-    MyHousekeepingJob,
-)
 ```
 
 !!! note
-    Ensure that any system jobs are imported on initialization. Otherwise, they won't be registered. This can be achieved by extending the PluginConfig's `ready()` method.
+    Ensure that any system jobs are imported on initialization. Otherwise, they won't be registered. This can be achieved by extending the PluginConfig's `ready()` method. For example:
+
+    ```python
+    def ready(self):
+        super().ready()
+
+        from .jobs import MyHousekeepingJob
+    ```
 
 ## Task queues