Add GDScript note to beginning of file, only show method-level note for methods with code blocks

Author: Bromeon

bindings_generator/src/class_docs.rs

@@ -124,19 +124,29 @@ impl GodotXMLDocs {
             }
         }
 
-        self.class_fn_desc
-            .insert((class.into(), method.into()), Self::reformat_as_rustdoc(doc));
+        self.class_fn_desc.insert(
+            (class.into(), method.into()),
+            Self::reformat_as_rustdoc(doc),
+        );
     }
 
     /// Takes the Godot documentation markup and transforms it to Rustdoc.
     /// Very basic approach with limitations, but already helps readability quite a bit.
     fn reformat_as_rustdoc(godot_doc: String) -> String {
-        godot_doc
+        let gdscript_note = if godot_doc.contains("[codeblock]") {
+            "_Sample code is GDScript unless otherwise noted._\n\n"
+        } else {
+            ""
+        };
+
+        let translated = godot_doc
             .replace("[code]", "`")
             .replace("[/code]", "`")
             .replace("[codeblock]", "```gdscript")
             .replace("[/codeblock]", "```")
             .replace("[b]", "**")
-            .replace("[/b]", "**")
+            .replace("[/b]", "**");
+
+        format!("{}{}", gdscript_note, translated)
     }
 }

bindings_generator/src/documentation.rs

@@ -52,7 +52,8 @@ pub fn generate_class_documentation(api: &Api, class: &GodotClass) -> TokenStrea
     let official_docs = format!(
         r#"## Official documentation
 
-See the [documentation of this class]({url}) in the Godot engine's official documentation."#,
+See the [documentation of this class]({url}) in the Godot engine's official documentation.
+The method descriptions are generated from it and typically contain code samples in GDScript, not Rust."#,
         url = official_doc_url(class),
     );