Merge e2b8da7 into 0fa4556

python/tk_multi_publish2/base_hooks/publish_plugin.py

@@ -451,15 +451,18 @@ def create_settings_widget(self, parent):
 
     def get_ui_settings(self, widget):
         """
-        Invoked by the publisher when the selection changes so the new settings
-        can be applied on the previously selected tasks.
+        Invoked by the Publisher when the selection changes. This method gathers the settings
+        on the previously selected task, so that they can be later used to repopulate the
+        custom UI if the task gets selected again. They will also be passed to the accept, validate,
+        publish and finalize methods, so that the settings can be used to drive the publish process.
 
         The widget argument is the widget that was previously created by
         `create_settings_widget`.
 
-        The method returns an dictionary, where the key is the name of a
+        The method returns a dictionary, where the key is the name of a
         setting that should be updated and the value is the new value of that
-        setting. Note that it is not necessary to return all the values from
+        setting. Note that it is up to you how you want to store the UI's state as
+        settings and you don't have to necessarily to return all the values from
         the UI. This is to allow the publisher to update a subset of settings
         when multiple tasks have been selected.