[clang] 8231182 - [libclang/python][NFC] Document how null cursors are handled (#140499)

[via cfe-commits]

Author: Vlad Serebrennikov
Date: 2025-05-19T12:30:22+04:00
New Revision: 8231182fed491b25a9597ba83cd284e097cc31ac

URL: https://github.com/llvm/llvm-project/commit/8231182fed491b25a9597ba83cd284e097cc31ac
DIFF: https://github.com/llvm/llvm-project/commit/8231182fed491b25a9597ba83cd284e097cc31ac.diff

LOG: [libclang/python][NFC] Document how null cursors are handled (#140499)

Now that we looked at this aspect closely and fixed things, I think we
can document this.

Added: 
    

Modified: 
    clang/bindings/python/clang/cindex.py

Removed: 
    


################################################################################
diff  --git a/clang/bindings/python/clang/cindex.py b/clang/bindings/python/clang/cindex.py
index f65bcad780a70..6f7243cdf80ac 100644
--- a/clang/bindings/python/clang/cindex.py
+++ b/clang/bindings/python/clang/cindex.py
@@ -1585,6 +1585,8 @@ class Cursor(Structure):
     """
     The Cursor class represents a reference to an element within the AST. It
     acts as a kind of iterator.
+
+    Null cursors are mapped to None.
     """
 
     _fields_ = [("_kind_id", c_int), ("xdata", c_int), ("data", c_void_p * 3)]