Skip to content

[LLDB][Docstrings] Fix some poorly formatted Docstrings #129605

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 7, 2025
Merged

[LLDB][Docstrings] Fix some poorly formatted Docstrings #129605

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6c8f3ee
Drop markdown backticks for codeblock
Jlalond Mar 3, 2025
fff16a7
Fix the other doc strings I know of
Jlalond Mar 6, 2025
dc48717
Merge branch 'main' into fix-process-docstring
Jlalond Mar 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions lldb/bindings/interface/SBProcessDocstrings.i
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,12 +260,12 @@ SBProcess supports thread iteration. For example (from test/lldbutil.py), ::
) lldb::SBProcess::DeallocateMemory;

%feature("docstring", "
Get a list of all the memory regions associated with this process.
```
Get a list of all the memory regions associated with this process. ::

readable_regions = []
for region in process.GetMemoryRegions():
if region.IsReadable():
readable_regions.append(region)
```

"
) lldb::SBProcess::GetMemoryRegions;
4 changes: 2 additions & 2 deletions lldb/bindings/interface/SBProgressDocstrings.i
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ specify a new detail. Some implementations differ on throttling updates and this
if the progress is deterministic or non-deterministic. For DAP, non-deterministic update messages have a higher
throttling rate than deterministic ones.

Below are examples in Python for deterministic and non-deterministic progresses.
Below are examples in Python for deterministic and non-deterministic progresses. ::

deterministic_progress1 = lldb.SBProgress('Deterministic Progress', 'Detail', 3, lldb.SBDebugger)
for i in range(3):
Expand All @@ -44,7 +44,7 @@ If you don't call Finalize() when the progress is not done, the progress object
garbage collected by the Python runtime, the end event will eventually get sent, but it is best not to
rely on the garbage collection when using lldb.SBProgress.

Non-deterministic progresses behave the same, but omit the total in the constructor.
Non-deterministic progresses behave the same, but omit the total in the constructor. ::

non_deterministic_progress = lldb.SBProgress('Non deterministic progress, 'Detail', lldb.SBDebugger)
for i in range(10):
Expand Down
9 changes: 3 additions & 6 deletions lldb/bindings/interface/SBSaveCoreOptionsDocstrings.i
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,13 @@
SBSaveCoreOptions includes API's to specify the memory regions and threads to include
when generating a core file. It extends the existing SaveCoreStyle option.

* eSaveCoreFull will save off all thread and memory regions, ignoring the memory regions and threads in
the options object.
* eSaveCoreFull will save off all thread and memory regions, ignoring the memory regions and threads in the options object.

* 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.
* 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.

* eSaveCoreStackOnly will capture all threads, but no memory regions unless specified.

* 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.
* 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.

Note that currently ELF Core files are not supported."
) lldb::SBSaveCoreOptions;
Expand Down
Loading