[Lldb-commits] [lldb] [LLDB][Docstrings] Fix some poorly formatted Docstrings (PR #129605)

[Jacob Lalonde via lldb-commits]

https://github.com/Jlalond updated https://github.com/llvm/llvm-project/pull/129605

>From 6c8f3ee0b033917213c802ddd978c63f8947616b Mon Sep 17 00:00:00 2001
From: Jacob Lalonde <jalalonde at fb.com>
Date: Mon, 3 Mar 2025 15:12:29 -0800
Subject: [PATCH 1/2] Drop markdown backticks for codeblock

---
 lldb/bindings/interface/SBProcessDocstrings.i | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/lldb/bindings/interface/SBProcessDocstrings.i b/lldb/bindings/interface/SBProcessDocstrings.i
index b5b22052a6094..2438a6bfc124c 100644
--- a/lldb/bindings/interface/SBProcessDocstrings.i
+++ b/lldb/bindings/interface/SBProcessDocstrings.i
@@ -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;

>From fff16a7d99d611846f5df7532f9ee9bcad49cf3b Mon Sep 17 00:00:00 2001
From: Jacob Lalonde <jalalonde at fb.com>
Date: Thu, 6 Mar 2025 15:56:36 -0800
Subject: [PATCH 2/2] Fix the other doc strings I know of

---
 lldb/bindings/interface/SBProgressDocstrings.i        | 4 ++--
 lldb/bindings/interface/SBSaveCoreOptionsDocstrings.i | 9 +++------
 2 files changed, 5 insertions(+), 8 deletions(-)

diff --git a/lldb/bindings/interface/SBProgressDocstrings.i b/lldb/bindings/interface/SBProgressDocstrings.i
index 7b7e1dc79187c..8d252ef1f370c 100644
--- a/lldb/bindings/interface/SBProgressDocstrings.i
+++ b/lldb/bindings/interface/SBProgressDocstrings.i
@@ -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): 
@@ -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):
diff --git a/lldb/bindings/interface/SBSaveCoreOptionsDocstrings.i b/lldb/bindings/interface/SBSaveCoreOptionsDocstrings.i
index 08bbdf89d68de..6efbe45d2d3ab 100644
--- a/lldb/bindings/interface/SBSaveCoreOptionsDocstrings.i
+++ b/lldb/bindings/interface/SBSaveCoreOptionsDocstrings.i
@@ -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;