Skip to content

Commit 3e8291d

Browse files
committed
must use double backquotes instead of single in RST
1 parent e14338e commit 3e8291d

File tree

1 file changed

+16
-15
lines changed

1 file changed

+16
-15
lines changed

python/binaryview.py

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3586,27 +3586,28 @@ def clear_user_global_pointer_value(self):
35863586
def set_user_global_pointer_value(self, value: variable.RegisterValue, confidence = 255):
35873587
"""
35883588
Set a user global pointer value. This is useful when the auto analysis fails to find out the value of the global
3589-
pointer, or the value is wrong. In this case, we can call `set_user_global_pointer_value` with a
3590-
`ConstantRegisterValue` or `ConstantPointerRegisterValue`to provide a user global pointer value to assist the
3589+
pointer, or the value is wrong. In this case, we can call ``set_user_global_pointer_value`` with a
3590+
``ConstantRegisterValue`` or ``ConstantPointerRegisterValue`` to provide a user global pointer value to assist the
35913591
analysis.
35923592
35933593
On the other hand, if the auto analysis figures out a global pointer value, but there should not be one, we can
3594-
call `set_user_global_pointer_value` with an `Undetermined` value to override it.
3594+
call ``set_user_global_pointer_value`` with an `Undetermined` value to override it.
35953595
35963596
Whenever a user global pointer value is set/cleared, an analysis update must occur for it to take effect and
35973597
all functions using the global pointer to be updated.
35983598
3599-
We can use `user_global_pointer_value_set` to query whether a user global pointer value is set, and use
3600-
`clear_user_global_pointer_value` to clear a user global pointer value. Note, `clear_user_global_pointer_value`
3601-
is different from calling `set_user_global_pointer_value` with an `Undetermined` value. The former clears the
3599+
We can use ``user_global_pointer_value_set`` to query whether a user global pointer value is set, and use
3600+
``clear_user_global_pointer_value`` to clear a user global pointer value. Note, ``clear_user_global_pointer_value``
3601+
is different from calling ``set_user_global_pointer_value`` with an ``Undetermined`` value. The former clears the
36023602
user global pointer value and let the analysis decide the global pointer value, whereas the latte forces the
36033603
global pointer value to become undetermined.
36043604
36053605
:param variable.RegisterValue value: the user global pointer value to be set
3606-
:param int confidence: the confidence value of the user global pointer value. In most cases this should be set
3607-
to 255. Setting a value lower than the confidence of the global pointer value from the auto analysis will cause
3608-
undesired effect.
3609-
:return:
3606+
:param int confidence: the confidence value of the user global pointer value. In most cases this should be \
3607+
set to 255. Setting a value lower than the confidence of the global pointer value from the auto analysis \
3608+
will cause undesired effect.
3609+
:return: None
3610+
:rtype: None
36103611
:Example:
36113612
36123613
>>> bv.global_pointer_value
@@ -9287,12 +9288,12 @@ def find_all_constant(
92879288
def search(self, pattern: str, start: int = None, end: int = None, raw: bool = False, ignore_case: bool = False, overlap: bool = False, align: int = 1,
92889289
limit: int = None, progress_callback: Optional[ProgressFuncType] = None, match_callback: Optional[DataMatchCallbackType] = None) -> QueueGenerator:
92899290
r"""
9290-
Searches for matches of the specified `pattern` within this BinaryView with an optionally provided address range specified by `start` and `end`.
9291+
Searches for matches of the specified ``pattern`` within this BinaryView with an optionally provided address range specified by ``start`` and ``end``.
92919292
The search pattern can be interpreted in various ways:
92929293
92939294
- specified as a string of hexadecimal digits where whitespace is ignored, and the '?' character acts as a wildcard
92949295
- a regular expression suitable for working with bytes
9295-
- or if the `raw` option is enabled, the pattern is interpreted as a raw string, and any special characters are escaped and interpreted literally
9296+
- or if the ``raw`` option is enabled, the pattern is interpreted as a raw string, and any special characters are escaped and interpreted literally
92969297
92979298
:param pattern: The pattern to search for.
92989299
:type pattern: :py:class:`str`
@@ -9306,10 +9307,10 @@ def search(self, pattern: str, start: int = None, end: int = None, raw: bool = F
93069307
:param int align: The alignment of matches, must be a power of 2 (default: 1).
93079308
:param int limit: The maximum number of matches to return (default: None).
93089309
:param callback progress_callback: An optional function to be called with the current progress and total count. \
9309-
This function should return a boolean value that decides whether the search should continue or stop.
9310+
This function should return a boolean value that decides whether the search should continue or stop.
93109311
:param callback match_callback: A function that gets called when a match is found. The callback takes two parameters: \
9311-
the address of the match, and the actual DataBuffer that satisfies the search. This function can return a boolean value \
9312-
that decides whether the search should continue or stop.
9312+
the address of the match, and the actual DataBuffer that satisfies the search. This function can return a boolean \
9313+
value that decides whether the search should continue or stop.
93139314
93149315
:return: A generator object that yields the offset and matched DataBuffer for each match found.
93159316
:rtype: QueueGenerator

0 commit comments

Comments
 (0)