Skip to content

Commit 31c03c9

Browse files
committed
[lldb][docs] Fix plaintext marker in variables doc
Single backtick tries to make a reference to something and if that fails, renders as plain text. These 3 weren't finding a reference and so produced a warning: variable.rst:975: WARNING: 'any' reference target not found: max_children
1 parent 9c83428 commit 31c03c9

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

lldb/docs/use/variable.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -972,13 +972,13 @@ Being more specific, in case of exceptions, LLDB might assume that the given
972972
object has no children or it might skip printing some children, as they are
973973
printed one by one.
974974

975-
[1] The `max_children` argument is optional (since lldb 3.8.0) and indicates the
975+
[1] The ``max_children`` argument is optional (since lldb 3.8.0) and indicates the
976976
maximum number of children that lldb is interested in (at this moment). If the
977977
computation of the number of children is expensive (for example, requires
978978
traversing a linked list to determine its size) your implementation may return
979-
`max_children` rather than the actual number. If the computation is cheap (e.g., the
979+
``max_children`` rather than the actual number. If the computation is cheap (e.g., the
980980
number is stored as a field of the object), then you can always return the true
981-
number of children (that is, ignore the `max_children` argument).
981+
number of children (that is, ignore the ``max_children`` argument).
982982

983983
[2] This method is optional. Also, a boolean value must be returned (since lldb
984984
3.1.0). If ``False`` is returned, then whenever the process reaches a new stop,

0 commit comments

Comments
 (0)