Просмотр исходного кода

docs/sphinx: Fix incorrect callback information

VodBox 5 лет назад
Родитель
Сommit
bc084bc10b
1 измененных файлов с 4 добавлено и 2 удалено
  1. 4 2
      docs/sphinx/scripting.rst

+ 4 - 2
docs/sphinx/scripting.rst

@@ -274,8 +274,10 @@ modules/namespaces).
 
 .. py:function:: obs_properties_add_button(properties, setting_name, text, callback)
 
-   Adds a button properties to an obs_properties_t object.  The callback
-   takes no parameters.
+   Adds a button property to an obs_properties_t object.  The callback
+   takes two parameters:  the first parameter is the obs_properties_t
+   object, and the second parameter is the obs_property_t for the
+   button.
 
    :param properties:   An obs_properties_t object.
    :param setting_name: A setting identifier string.