[LLDB][Docstrings] Fix some poorly formatted Docstrings

[Jlalond]

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.

[llvmbot]

@llvm/pr-subscribers-lldb

Author: Jacob Lalonde (Jlalond)

Changes

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.

---

Full diff: https://github.com/llvm/llvm-project/pull/129605.diff

1 Files Affected:

• (modified) lldb/bindings/interface/SBProcessDocstrings.i (+6-6)

diff --git a/lldb/bindings/interface/SBProcessDocstrings.i b/lldb/bindings/interface/SBProcessDocstrings.i
index b5b22052a6094..e2348795d10d9 100644
--- a/lldb/bindings/interface/SBProcessDocstrings.i
+++ b/lldb/bindings/interface/SBProcessDocstrings.i
@@ -261,11 +261,11 @@ SBProcess supports thread iteration. For example (from test/lldbutil.py), ::
 
 %feature("docstring", "
     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)
-    ```
+    
+    readable_regions = []
+    for region in process.GetMemoryRegions():
+        if region.IsReadable():
+            readable_regions.append(region)
+    
 "
 ) lldb::SBProcess::GetMemoryRegions;

[Jlalond]

@JDevlieghere I should've closed this, but I'm actually going to fix a couple spots around the codebase. It looks like Swig will give a codeblock on ::, looking at SBTargetDocstrings.i. So I'm going to reuse this patch to fix atleast SBProcess, SBProgress, and I think MemoryRegionInfo.

Is there a good place to add a blurb about these swig gotcha's? Maybe a .md in bindings/swig?

[Jlalond]

Attached are some images of docstrings I'm cleaning up (I also made the mess :P).

SBSaveCore formatting breaks on the newline

SBProgress has quote blocks instead of just a code block

[Jlalond]

@clayborg These are those docstring cleanups I pinged you about

[JDevlieghere]

Is there a good place to add a blurb about these swig gotcha's? Maybe a .md in bindings/swig?

That's a great question. There's a lot of institutional knowledge about how SWIG is used in LLDB that hasn't been written down. I think it'd be worth it to have a page on the website (under the section "developing lldb") to cover that. I'd be happy to contribute with some of the caveats/challenges/intricacies of how we use SWIG in LLDB.