diff options
| author | Jordan Wiens <jordan@psifertex.com> | 2023-04-19 15:14:58 -0400 |
|---|---|---|
| committer | Jordan Wiens <jordan@psifertex.com> | 2023-04-19 15:14:58 -0400 |
| commit | 5e91cb790081dd4335b97892e3c284cb75fb8c32 (patch) | |
| tree | 1ea78073aab8d0af2f9781019fb082773c127972 /python | |
| parent | 57202a56a057e12f679b47a73f108551ee4a1cce (diff) | |
small documentation fixes
Diffstat (limited to 'python')
| -rw-r--r-- | python/binaryview.py | 1 | ||||
| -rw-r--r-- | python/deprecation.py | 3 | ||||
| -rw-r--r-- | python/interaction.py | 4 |
3 files changed, 4 insertions, 4 deletions
diff --git a/python/binaryview.py b/python/binaryview.py index 980876b8..39908e49 100644 --- a/python/binaryview.py +++ b/python/binaryview.py @@ -2562,6 +2562,7 @@ class BinaryView: """ Dict of symbols (read-only) Items in the dict are lists of all symbols matching that name. + :Example: >>> bv.symbols['_main'] diff --git a/python/deprecation.py b/python/deprecation.py index e6c5a482..f87be905 100644 --- a/python/deprecation.py +++ b/python/deprecation.py @@ -117,12 +117,13 @@ def deprecated(deprecated_in=None, removed_in=None, current_version=None, """Decorate a function to signify its deprecation This function wraps a method that will soon be removed and does two things: + * The docstring of the method will be modified to include a notice about deprecation, e.g., "Deprecated since 0.9.11. Use foo instead." * Raises a :class:`~deprecation.DeprecatedWarning` via the :mod:`warnings` module, which is a subclass of the built-in :class:`DeprecationWarning`. Note that built-in - :class:`DeprecationWarning`s are ignored by default, so for users + :class:`DeprecationWarning` are ignored by default, so for users to be informed of said warnings they will need to enable them--see the :mod:`warnings` module documentation for more details. diff --git a/python/interaction.py b/python/interaction.py index 82066191..4b296ab3 100644 --- a/python/interaction.py +++ b/python/interaction.py @@ -1389,9 +1389,7 @@ def run_progress_dialog(title: str, can_cancel: bool, task: Callable[[Callable[[ :param title: Dialog title :param can_cancel: If the task can be cancelled - :param task: Function to perform the task, taking as a parameter a function which should - be called to report progress updates and check for cancellation. If the progress function - returns false, the user has requested to cancel, and the task should handle this appropriately. + :param task: Function to perform the task, taking as a parameter a function which should be called to report progress updates and check for cancellation. If the progress function returns false, the user has requested to cancel, and the task should handle this appropriately. :return: True if not cancelled """ |