Skip to content

Commit ec0d430

Browse files
committed
must escape newlines in long parameter descriptions
1 parent 3e8291d commit ec0d430

File tree

3 files changed

+10
-10
lines changed

3 files changed

+10
-10
lines changed

python/firmwareninja.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -773,9 +773,9 @@ def get_reference_tree(
773773
"""
774774
``get_reference_tree`` returns a tree of reference nodes for a memory region, function, or address
775775
776-
:param Union[Section, FirmwareNinjaDevice, DataVariable, Function, int] location: Memory location to build the
776+
:param Union[Section, FirmwareNinjaDevice, DataVariable, Function, int] location: Memory location to build the \
777777
reference tree for
778-
:param list[FirmwareNinjaFunctionMemoryAccesses] fma: List of function memory accesses or None to use cross
778+
:param list[FirmwareNinjaFunctionMemoryAccesses] fma: List of function memory accesses or None to use cross \
779779
references. None should only be supplied if location is a Function, DataVariable, or address.
780780
:param Optional[int] value: Only include the node in the tree if this value is written to the location
781781
:return: Root reference node containing the reference tree

python/scriptingprovider.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1284,12 +1284,12 @@ def register_magic_variable(
12841284
"""
12851285
Add a magic variable to all scripting instances created by the scripting provider
12861286
:param name: Variable name identifier to be used in the interpreter
1287-
:param get_value: Function to call, before every time a script is evaluated,
1287+
:param get_value: Function to call, before every time a script is evaluated, \
12881288
to get the value of the variable
1289-
:param set_value: (Optional) Function to call after a script is evaluated, if the
1290-
value of the variable has changed during the course of the script.
1291-
If None, a warning will be printed stating that the variable is read-only.
1292-
Signature:
1289+
:param set_value: (Optional) Function to call after a script is evaluated, if the \
1290+
value of the variable has changed during the course of the script. \
1291+
If None, a warning will be printed stating that the variable is read-only. \
1292+
Signature: \
12931293
(instance: PythonScriptingInstance, old_value: any, new_value: any) -> None
12941294
:param depends_on: List of other variables whose values on which this variable's value depends
12951295
"""

python/workflow.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -124,10 +124,10 @@ def set_mlil_function(
124124
Set the Medium Level IL function in the current analysis, giving updated
125125
Low Level IL (SSA) to Medium Level IL instruction and expression mappings.
126126
:param new_func: New MLIL function
127-
:param llil_ssa_to_mlil_instr_map: Mapping from every LLIL SSA instruction to
127+
:param llil_ssa_to_mlil_instr_map: Mapping from every LLIL SSA instruction to \
128128
every MLIL instruction
129-
:param llil_ssa_to_mlil_expr_map: Mapping from every LLIL SSA expression to
130-
one or more MLIL expressions (first expression
129+
:param llil_ssa_to_mlil_expr_map: Mapping from every LLIL SSA expression to \
130+
one or more MLIL expressions (first expression \
131131
will be the primary)
132132
"""
133133
if llil_ssa_to_mlil_instr_map is None or llil_ssa_to_mlil_expr_map is None:

0 commit comments

Comments
 (0)