[clang] [libclang/python][NFC] Explain how null cursors are handled in docstring (PR #140499)

[via cfe-commits]

llvmbot wrote:


<!--LLVM PR SUMMARY COMMENT-->

@llvm/pr-subscribers-clang

Author: Vlad Serebrennikov (Endilll)

<details>
<summary>Changes</summary>

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

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


1 Files Affected:

- (modified) clang/bindings/python/clang/cindex.py (+2) 


``````````diff
diff --git a/clang/bindings/python/clang/cindex.py b/clang/bindings/python/clang/cindex.py
index f65bcad780a70..82a6197bf61af 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.
+
+    Methods of this class return null cursors as None.
     """
 
     _fields_ = [("_kind_id", c_int), ("xdata", c_int), ("data", c_void_p * 3)]

``````````

</details>


https://github.com/llvm/llvm-project/pull/140499