diff options
| author | Mason Reed <mason@vector35.com> | 2024-10-19 19:13:26 -0400 |
|---|---|---|
| committer | Mason Reed <mason@vector35.com> | 2024-10-19 19:13:26 -0400 |
| commit | b42157dd6b361bf9ab38fc7b010870a1d143ba46 (patch) | |
| tree | 079ed624d8d27fb998010eb0fad998d03cb945e4 /python | |
| parent | e7895a2c36189bc1c3010a48b47656e861607640 (diff) | |
Add misc docs to BinaryDataNotification
Should make it more clear when certain callbacks are called.
Diffstat (limited to 'python')
| -rw-r--r-- | python/binaryview.py | 14 |
1 files changed, 13 insertions, 1 deletions
diff --git a/python/binaryview.py b/python/binaryview.py index 8a38e819..fe270c9a 100644 --- a/python/binaryview.py +++ b/python/binaryview.py @@ -223,7 +223,7 @@ class BinaryDataNotification: with a `BinaryView` using the `register_notification` method. By default, a `BinaryDataNotification` instance receives notifications for all available notification types. It - is recommended for users of this interface to initialize the `BinaryDataNotification` base class with with specific + is recommended for users of this interface to initialize the `BinaryDataNotification` base class with specific callbacks of interest by passing the appropriate `NotificationType` flags into the `__init__` constructor. Handlers provided by the user should aim to limit the amount of processing within the callback. The @@ -293,9 +293,15 @@ class BinaryDataNotification: pass def function_added(self, view: 'BinaryView', func: '_function.Function') -> None: + """ + .. note:: `function_updated` will be triggered instead when a user function is added over an auto function. + """ pass def function_removed(self, view: 'BinaryView', func: '_function.Function') -> None: + """ + .. note:: `function_updated` will be triggered instead when a user function is removed over an auto function. + """ pass def function_updated(self, view: 'BinaryView', func: '_function.Function') -> None: @@ -305,9 +311,15 @@ class BinaryDataNotification: pass def data_var_added(self, view: 'BinaryView', var: 'DataVariable') -> None: + """ + .. note:: `data_var_updated` will be triggered instead when a user data variable is added over an auto data variable. + """ pass def data_var_removed(self, view: 'BinaryView', var: 'DataVariable') -> None: + """ + .. note:: `data_var_updated` will be triggered instead when a user data variable is removed over an auto data variable. + """ pass def data_var_updated(self, view: 'BinaryView', var: 'DataVariable') -> None: |