document the expected format for pyo3import attributes

MusicalNinjaDad · Apr 10, 2024 · a5627ef · a5627ef
1 parent 0b78eba
commit a5627ef
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/pyo3-testing/src/lib.rs b/pyo3-testing/src/lib.rs
@@ -44,6 +44,8 @@ struct Pyo3Import {
 }
 
 impl Parse for Pyo3Import {
+    /// Attributes parsing to Pyo3Imports should have the format:
+    /// `moduleidentifier: from modulename import functionname`
     fn parse(input: ParseStream<'_>) -> syn::Result<Self> {
         let moduleidentifier = input.parse()?;
         let _colon: Colon = input.parse()?;