Skip to content

Conversation

@Jlalond
Copy link
Contributor

@Jlalond Jlalond commented Sep 8, 2025

Earlier today I was looking at the SBProgress documentation with a colleague and found another instance where the swig block wasn't formatting correctly. I've adjusted the docs slightly to fix this. I don't actually know how to see a preview of our docstrings but I believe this will fix it.

image

@llvmbot llvmbot added the lldb label Sep 8, 2025
@llvmbot
Copy link
Member

llvmbot commented Sep 8, 2025

@llvm/pr-subscribers-lldb

Author: Jacob Lalonde (Jlalond)

Changes

Earlier today I was looking at the SBProgress documentation with a colleague and found another instance where the swig block wasn't formatting correctly. I've adjusted the docs slightly to fix this. I don't actually know how to see a preview of our docstrings but I believe this will fix it.

<img width="829" height="234" alt="image" src="https://github.com/user-attachments/assets/8ef3a2df-92b9-4157-a452-f5e1ec51aa9a" />


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

1 Files Affected:

  • (modified) lldb/bindings/interface/SBProgressDocstrings.i (+2-1)
diff --git a/lldb/bindings/interface/SBProgressDocstrings.i b/lldb/bindings/interface/SBProgressDocstrings.i
index 4c001d7d5ebcb..218d0c973cc40 100644
--- a/lldb/bindings/interface/SBProgressDocstrings.i
+++ b/lldb/bindings/interface/SBProgressDocstrings.i
@@ -57,8 +57,9 @@ Additionally for Python, progress is supported in a with statement. ::
     with lldb.SBProgress('Non deterministic progress', 'Detail', lldb.SBDebugger) as progress:
         for i in range(10):
             progress.Increment(1)
-    # The progress object is automatically finalized when the with statement
+            ...
 
+The progress object is automatically finalized on the exit of the with block.
 ") lldb::SBProgress;    
 
 %feature("docstring",

@Jlalond
Copy link
Contributor Author

Jlalond commented Sep 8, 2025

@JDevlieghere FYI -- Related I might try to see if I can create a local script to generate the html to view these doc strings. I still struggle with Swigs formatting.

@Jlalond Jlalond enabled auto-merge (squash) September 8, 2025 21:52
@Jlalond Jlalond merged commit 1e17113 into llvm:main Sep 8, 2025
11 checks passed
@Jlalond Jlalond deleted the sb-progress-doc-fix branch September 8, 2025 21:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants