Skip to content

Commit 5b1c281

Browse files
authored
[LLDB][Docstrings] Fix some poorly formatted Docstrings (#129605)
I was looking earlier on the public doc website, and noticed the markdown was very badly mangled for this recent docstring that I added. So I'm dropping the backticks and just leaving the snippet. ![image](https://github.com/user-attachments/assets/de63ab73-3bd5-4f8f-a07c-9f6accfee7e1)
1 parent d5cef39 commit 5b1c281

File tree

3 files changed

+8
-11
lines changed

3 files changed

+8
-11
lines changed

lldb/bindings/interface/SBProcessDocstrings.i

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -260,12 +260,12 @@ SBProcess supports thread iteration. For example (from test/lldbutil.py), ::
260260
) lldb::SBProcess::DeallocateMemory;
261261

262262
%feature("docstring", "
263-
Get a list of all the memory regions associated with this process.
264-
```
263+
Get a list of all the memory regions associated with this process. ::
264+
265265
readable_regions = []
266266
for region in process.GetMemoryRegions():
267267
if region.IsReadable():
268268
readable_regions.append(region)
269-
```
269+
270270
"
271271
) lldb::SBProcess::GetMemoryRegions;

lldb/bindings/interface/SBProgressDocstrings.i

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ specify a new detail. Some implementations differ on throttling updates and this
2323
if the progress is deterministic or non-deterministic. For DAP, non-deterministic update messages have a higher
2424
throttling rate than deterministic ones.
2525
26-
Below are examples in Python for deterministic and non-deterministic progresses.
26+
Below are examples in Python for deterministic and non-deterministic progresses. ::
2727
2828
deterministic_progress1 = lldb.SBProgress('Deterministic Progress', 'Detail', 3, lldb.SBDebugger)
2929
for i in range(3):
@@ -44,7 +44,7 @@ If you don't call Finalize() when the progress is not done, the progress object
4444
garbage collected by the Python runtime, the end event will eventually get sent, but it is best not to
4545
rely on the garbage collection when using lldb.SBProgress.
4646
47-
Non-deterministic progresses behave the same, but omit the total in the constructor.
47+
Non-deterministic progresses behave the same, but omit the total in the constructor. ::
4848
4949
non_deterministic_progress = lldb.SBProgress('Non deterministic progress, 'Detail', lldb.SBDebugger)
5050
for i in range(10):

lldb/bindings/interface/SBSaveCoreOptionsDocstrings.i

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,13 @@
44
SBSaveCoreOptions includes API's to specify the memory regions and threads to include
55
when generating a core file. It extends the existing SaveCoreStyle option.
66
7-
* eSaveCoreFull will save off all thread and memory regions, ignoring the memory regions and threads in
8-
the options object.
7+
* eSaveCoreFull will save off all thread and memory regions, ignoring the memory regions and threads in the options object.
98
10-
* eSaveCoreDirtyOnly pages will capture all threads and all rw- memory regions, in addition to the regions specified
11-
in the options object if they are not already captured.
9+
* eSaveCoreDirtyOnly pages will capture all threads and all rw- memory regions, in addition to the regions specified in the options object if they are not already captured.
1210
1311
* eSaveCoreStackOnly will capture all threads, but no memory regions unless specified.
1412
15-
* eSaveCoreCustomOnly Custom defers entirely to the SBSaveCoreOptions object and will only save what is specified.
16-
Picking custom and specifying nothing will result in an error being returned.
13+
* eSaveCoreCustomOnly Custom defers entirely to the SBSaveCoreOptions object and will only save what is specified. Picking custom and specifying nothing will result in an error being returned.
1714
1815
Note that currently ELF Core files are not supported."
1916
) lldb::SBSaveCoreOptions;

0 commit comments

Comments
 (0)