Merge pull request #1048 from davidhewitt/fix-from-type-ptr-doc

Fix doc for PyType::from_type_ptr
PyO3 · Jul 18, 2020 · 264e885 · 264e885
2 parents 8bbdbc4 + 9f3e13e
commit 264e885
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/src/types/typeobject.rs b/src/types/typeobject.rs
@@ -29,8 +29,10 @@ impl PyType {
     }
 
     /// Retrieves the `PyType` instance for the given FFI pointer.
-    /// This increments the reference count on the type object.
-    /// Undefined behavior if the pointer is NULL or invalid.
+    ///
+    /// # Safety
+    /// - The pointer must be non-null.
+    /// - The pointer must be valid for the entire of the lifetime for which the reference is used.
     #[inline]
     pub unsafe fn from_type_ptr(py: Python, p: *mut ffi::PyTypeObject) -> &PyType {
         py.from_borrowed_ptr(p as *mut ffi::PyObject)