docs: not all capsule are modules attributes

PyO3 · Nov 18, 2023 · c423ff6 · c423ff6
1 parent be7c625
commit c423ff6
Showing 1 changed file with 6 additions and 4 deletions.
diff --git a/src/types/capsule.rs b/src/types/capsule.rs
@@ -123,8 +123,9 @@ impl PyCapsule {
 
     /// Imports an existing capsule.
     ///
-    /// The `name` should match the path to the module attribute exactly in the form
-    /// of `"module.attribute"`, which should be the same as the name within the capsule.
+    /// If this capsule represents a module attribute, the `name` should match the path
+    /// to the module attribute exactly in the form of `"module.attribute"`, which should
+    /// be the same as the name within the capsule.
     ///
     /// # Safety
     ///
@@ -140,8 +141,9 @@ impl PyCapsule {
 
     /// Imports an existing capsule, returning a mutable reference to the value.
     ///
-    /// The `name` should match the path to the module attribute exactly in the form
-    /// of `"module.attribute"`, which should be the same as the name within the capsule.
+    /// If this capsule represents a module attribute, the `name` should match the path
+    /// to the module attribute exactly in the form of `"module.attribute"`, which should
+    /// be the same as the name within the capsule.
     ///
     /// # Safety
     ///