Removed docs on members

Jij-Inc · Feb 19, 2025 · ad4903c · ad4903c
1 parent c8226d0
commit ad4903c
Show file tree

Hide file tree

Showing 4 changed files with 2 additions and 19 deletions.
diff --git a/examples/pure/pure.pyi b/examples/pure/pure.pyi
@@ -20,12 +20,10 @@ class Number(Enum):
 
     @property
     def is_float(self) -> builtins.bool:
-        """Whether the number is a float."""
         ...
 
     @property
     def is_integer(self) -> builtins.bool:
-        """Whether the number is an integer."""
         ...
 
 def ahash_dict() -> builtins.dict[builtins.str, builtins.int]: ...

diff --git a/pyo3-stub-gen/src/generate/member.rs b/pyo3-stub-gen/src/generate/member.rs
@@ -1,5 +1,3 @@
-use itertools::Itertools;
-
 use crate::{generate::*, type_info::*, TypeInfo};
 use std::{
     collections::HashSet,
@@ -12,7 +10,6 @@ pub struct MemberDef {
     pub is_property: bool,
     pub name: &'static str,
     pub r#type: TypeInfo,
-    pub doc: &'static str,
 }
 
 impl Import for MemberDef {
@@ -27,27 +24,19 @@ impl From<&MemberInfo> for MemberDef {
             is_property: false,
             name: info.name,
             r#type: (info.r#type)(),
-            doc: info.doc,
         }
     }
 }
 
 impl fmt::Display for MemberDef {
     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
         let indent = indent();
-        let doc = self.doc.split("\n").join(&format!("\n{indent}"));
         if self.is_property {
             writeln!(f, "{indent}@property")?;
             writeln!(f, "{indent}def {}(self) -> {}:", self.name, self.r#type)?;
-            if !doc.is_empty() {
-                writeln!(f, r#"{indent}    """{doc}""""#)?;
-            }
             writeln!(f, "{indent}    ...")
         } else {
             writeln!(f, "{indent}{}: {}", self.name, self.r#type)?;
-            if !doc.is_empty() {
-                writeln!(f, r#"{indent}"""{doc}""""#)?;
-            }
             Ok(())
         }
     }

diff --git a/pyo3-stub-gen/src/generate/stub_info.rs b/pyo3-stub-gen/src/generate/stub_info.rs
@@ -130,7 +130,6 @@ impl StubInfoBuilder {
                         is_property: false,
                         name: getter.name,
                         r#type: (getter.r#type)(),
-                        doc: getter.doc,
                     });
                 }
                 for method in info.methods {
@@ -146,7 +145,6 @@ impl StubInfoBuilder {
                         is_property: true,
                         name: getter.name,
                         r#type: (getter.r#type)(),
-                        doc: getter.doc,
                     });
                 }
                 for method in info.methods {

diff --git a/pyo3-stub-gen/src/lib.rs b/pyo3-stub-gen/src/lib.rs
@@ -40,12 +40,12 @@
 //!             MemberInfo {
 //!                 name: "name",
 //!                 r#type: <String as ::pyo3_stub_gen::PyStubType>::type_output,
-//!                 doc: "Name docstring",
+//!                 doc: "",
 //!             },
 //!             MemberInfo {
 //!                 name: "description",
 //!                 r#type: <Option<String> as ::pyo3_stub_gen::PyStubType>::type_output,
-//!                 doc: "Description docstring",
+//!                 doc: "",
 //!             },
 //!         ],
 //!         doc: "Docstring used in Python",
@@ -61,9 +61,7 @@
 //!     Docstring used in Python
 //!     """
 //!     name: str
-//!     """Name docstring"""
 //!     description: Optional[str]
-//!     """Description docstring"""
 //! ```
 //!
 //! We want to generate this [type_info::PyClassInfo] section automatically from `MyClass` Rust struct definition.