summaryrefslogtreecommitdiff
path: root/python
diff options
context:
space:
mode:
authorJordan Wiens <jordan@psifertex.com>2025-07-02 17:08:06 -0400
committerJordan Wiens <jordan@psifertex.com>2025-07-02 17:09:26 -0400
commitec0d4308171b4fd67242e084eceede31c33a9d08 (patch)
tree3de2b49cc81015a9bc4896a3e714959849f725c6 /python
parent3e8291d2bfc75af0edf862808dd9849c72d27095 (diff)
must escape newlines in long parameter descriptions
Diffstat (limited to 'python')
-rw-r--r--python/firmwareninja.py4
-rw-r--r--python/scriptingprovider.py10
-rw-r--r--python/workflow.py6
3 files changed, 10 insertions, 10 deletions
diff --git a/python/firmwareninja.py b/python/firmwareninja.py
index ce628459..a48c8be1 100644
--- a/python/firmwareninja.py
+++ b/python/firmwareninja.py
@@ -773,9 +773,9 @@ class FirmwareNinja:
"""
``get_reference_tree`` returns a tree of reference nodes for a memory region, function, or address
- :param Union[Section, FirmwareNinjaDevice, DataVariable, Function, int] location: Memory location to build the
+ :param Union[Section, FirmwareNinjaDevice, DataVariable, Function, int] location: Memory location to build the \
reference tree for
- :param list[FirmwareNinjaFunctionMemoryAccesses] fma: List of function memory accesses or None to use cross
+ :param list[FirmwareNinjaFunctionMemoryAccesses] fma: List of function memory accesses or None to use cross \
references. None should only be supplied if location is a Function, DataVariable, or address.
:param Optional[int] value: Only include the node in the tree if this value is written to the location
:return: Root reference node containing the reference tree
diff --git a/python/scriptingprovider.py b/python/scriptingprovider.py
index bb04ce86..e3ca09f6 100644
--- a/python/scriptingprovider.py
+++ b/python/scriptingprovider.py
@@ -1284,12 +1284,12 @@ class PythonScriptingProvider(ScriptingProvider):
"""
Add a magic variable to all scripting instances created by the scripting provider
:param name: Variable name identifier to be used in the interpreter
- :param get_value: Function to call, before every time a script is evaluated,
+ :param get_value: Function to call, before every time a script is evaluated, \
to get the value of the variable
- :param set_value: (Optional) Function to call after a script is evaluated, if the
- value of the variable has changed during the course of the script.
- If None, a warning will be printed stating that the variable is read-only.
- Signature:
+ :param set_value: (Optional) Function to call after a script is evaluated, if the \
+ value of the variable has changed during the course of the script. \
+ If None, a warning will be printed stating that the variable is read-only. \
+ Signature: \
(instance: PythonScriptingInstance, old_value: any, new_value: any) -> None
:param depends_on: List of other variables whose values on which this variable's value depends
"""
diff --git a/python/workflow.py b/python/workflow.py
index bf48e5d8..6e4c6730 100644
--- a/python/workflow.py
+++ b/python/workflow.py
@@ -124,10 +124,10 @@ class AnalysisContext:
Set the Medium Level IL function in the current analysis, giving updated
Low Level IL (SSA) to Medium Level IL instruction and expression mappings.
:param new_func: New MLIL function
- :param llil_ssa_to_mlil_instr_map: Mapping from every LLIL SSA instruction to
+ :param llil_ssa_to_mlil_instr_map: Mapping from every LLIL SSA instruction to \
every MLIL instruction
- :param llil_ssa_to_mlil_expr_map: Mapping from every LLIL SSA expression to
- one or more MLIL expressions (first expression
+ :param llil_ssa_to_mlil_expr_map: Mapping from every LLIL SSA expression to \
+ one or more MLIL expressions (first expression \
will be the primary)
"""
if llil_ssa_to_mlil_instr_map is None or llil_ssa_to_mlil_expr_map is None: