summaryrefslogtreecommitdiff
path: root/python
diff options
context:
space:
mode:
authorJordan Wiens <jordan@psifertex.com>2021-02-18 14:31:49 -0500
committerJordan Wiens <jordan@psifertex.com>2021-02-18 14:31:49 -0500
commitab38220c60d59f7bc164c76bde72201746a53da9 (patch)
treeb02006849774a20dd911682f829f21e6b89c1b86 /python
parent9f4c4a0a819786b5d08e2a25cd8be080a8acf980 (diff)
fix syntax error in pydoc warnings
Diffstat (limited to 'python')
-rw-r--r--python/binaryview.py6
-rw-r--r--python/function.py2
2 files changed, 4 insertions, 4 deletions
diff --git a/python/binaryview.py b/python/binaryview.py
index cbfc47ef..f6c05b81 100644
--- a/python/binaryview.py
+++ b/python/binaryview.py
@@ -235,7 +235,7 @@ class AnalysisCompletionEvent(object):
"""
The ``cancel`` method will cancel analysis for an :class:`AnalysisCompletionEvent`.
- .. warning: This method should only be used when the system is being shut down and no further analysis should be done afterward.
+ .. warning:: This method should only be used when the system is being shut down and no further analysis should be done afterward.
"""
self.callback = self._empty_callback
@@ -3026,7 +3026,7 @@ class BinaryView(object):
"""
``remove_function`` removes the function ``func`` from the list of functions
- .. warning: This method should only be used when the function that is removed is expected to re-appear after any other analysis executes that could re-add it. Most users will want to use :func:`remove_user_function` in their scripts.
+ .. warning:: This method should only be used when the function that is removed is expected to re-appear after any other analysis executes that could re-add it. Most users will want to use :func:`remove_user_function` in their scripts.
:param Function func: a Function object.
:rtype: None
@@ -4626,7 +4626,7 @@ class BinaryView(object):
The callee of this function is not responsible for maintaining the lifetime of the returned AnalysisCompletionEvent object.
- .. warning: The built-in python console automatically updates analysis after every command is run, which means this call back may not behave as expected if entered interactively.
+ .. warning:: The built-in python console automatically updates analysis after every command is run, which means this call back may not behave as expected if entered interactively.
:param callback callback: A function to be called with no parameters when analysis has completed.
:return: An initialized AnalysisCompletionEvent object.
diff --git a/python/function.py b/python/function.py
index da6d66e2..783df87e 100644
--- a/python/function.py
+++ b/python/function.py
@@ -2872,7 +2872,7 @@ class Function(object):
"""
``set_auto_instr_highlight`` highlights the instruction at the specified address with the supplied color
- .. warning: Use only in analysis plugins. Do not use in regular plugins, as colors won't be saved to the database.
+ .. warning:: Use only in analysis plugins. Do not use in regular plugins, as colors won't be saved to the database.
:param int addr: virtual address of the instruction to be highlighted
:param HighlightStandardColor|highlight.HighlightColor color: Color value to use for highlighting