Merge pull request #1386 from godot-rust/qol/cleanups

Various small cleanups

Author: Bromeon

check.sh

@@ -142,7 +142,13 @@ function findGodot() {
 # builtins like `test`.
 
 function cmd_fmt() {
-    run cargo fmt --all -- --check
+    # Run rustfmt in nightly toolchain if available.
+    if [[ $(rustup toolchain list) =~ nightly ]]; then
+        run cargo +nightly fmt --all -- --check
+    else
+        log -e "${YELLOW}Warning: nightly toolchain not found; stable rustfmt might not pass CI.${END}"
+        run cargo fmt --all -- --check
+    fi
 }
 
 function cmd_clippy() {

godot-codegen/src/generator/signals.rs

@@ -10,6 +10,8 @@
 // for these signals, and integration is slightly different due to lack of WithBaseField trait. Nonetheless, some parts could potentially
 // be extracted into a future crate shared by godot-codegen and godot-macros.
 
+// TODO(v0.5): signal parameters are Gd<T> instead of conservatively Option<Gd<T>>, which is a bug.
+
 use proc_macro2::{Ident, TokenStream};
 use quote::{format_ident, quote};
 

godot-codegen/src/models/domain.rs

@@ -737,19 +737,22 @@ pub enum RustTy {
     /// C-style raw pointer to a `RustTy`.
     RawPointer { inner: Box<RustTy>, is_const: bool },
 
-    /// `Array<Gd<PhysicsBody3D>>`
+    /// `Array<Gd<PhysicsBody3D>>`. Never contains `Option` elements.
     EngineArray {
         tokens: TokenStream,
-        #[allow(dead_code)] // only read in minimal config
+
+        #[allow(dead_code)] // Only read in minimal config.
         elem_class: String,
     },
 
     /// `module::Enum` or `module::Bitfield`
     EngineEnum {
         tokens: TokenStream,
-        /// `None` for globals
-        #[allow(dead_code)] // only read in minimal config
+
+        /// `None` for globals.
+        #[allow(dead_code)] // Only read in minimal config.
         surrounding_class: Option<String>,
+
         is_bitfield: bool,
     },
 
@@ -794,7 +797,6 @@ impl RustTy {
     /// Returns tokens without `Option<T>` wrapper, even for nullable engine classes.
     ///
     /// For `EngineClass`, always returns `Gd<T>` regardless of nullability. For other types, behaves the same as `ToTokens`.
-    // TODO(v0.5): only used for signal params, which is a bug. Those should conservatively be Option<Gd<T>> as well.
     // Might also be useful to directly extract inner `gd_tokens` field.
     pub fn tokens_non_null(&self) -> TokenStream {
         match self {

godot-core/src/builtin/basis.rs

@@ -703,22 +703,22 @@ mod test {
             Basis::from_euler(EulerOrder::XYZ, euler_xyz_from_rotation);
 
         let res = to_rotation.inverse() * rotation_from_xyz_computed_euler;
+        let col_a = res.col_a();
+        let col_b = res.col_b();
+        let col_c = res.col_c();
 
         assert!(
-        (res.col_a() - Vector3::new(1.0, 0.0, 0.0)).length() <= 0.1,
-        "Double check with XYZ rot order failed, due to X {} with {deg_original_euler} using {rot_order:?}",
-        res.col_a(),
-    );
+            (col_a - Vector3::new(1.0, 0.0, 0.0)).length() <= 0.1,
+            "Double check with XYZ rot order failed, due to A {col_a} with {deg_original_euler} using {rot_order:?}",
+        );
         assert!(
-        (res.col_b() - Vector3::new(0.0, 1.0, 0.0)).length() <= 0.1,
-        "Double check with XYZ rot order failed, due to Y {} with {deg_original_euler} using {rot_order:?}",
-        res.col_b(),
-    );
+            (col_b - Vector3::new(0.0, 1.0, 0.0)).length() <= 0.1,
+            "Double check with XYZ rot order failed, due to B {col_b} with {deg_original_euler} using {rot_order:?}",
+        );
         assert!(
-        (res.col_c() - Vector3::new(0.0, 0.0, 1.0)).length() <= 0.1,
-        "Double check with XYZ rot order failed, due to Z {} with {deg_original_euler} using {rot_order:?}",
-        res.col_c(),
-    );
+            (col_c - Vector3::new(0.0, 0.0, 1.0)).length() <= 0.1,
+            "Double check with XYZ rot order failed, due to C {col_c} with {deg_original_euler} using {rot_order:?}",
+        );
     }
 
     #[test]

godot-core/src/builtin/callable.rs

@@ -461,7 +461,7 @@ impl Callable {
         /// _Godot equivalent: `hash`_
     }
 
-    #[deprecated = "renamed to hash_u32"]
+    #[deprecated = "renamed to `hash_u32`"]
     pub fn hash(&self) -> u32 {
         self.as_inner().hash().try_into().unwrap()
     }

godot-core/src/builtin/collections/array.rs

@@ -293,7 +293,7 @@ impl<T: ArrayElement> Array<T> {
         /// because different arrays can have identical hash values due to hash collisions.
     }
 
-    #[deprecated = "renamed to hash_u32"]
+    #[deprecated = "renamed to `hash_u32`"]
     pub fn hash(&self) -> u32 {
         self.as_inner().hash().try_into().unwrap()
     }

godot-core/src/builtin/collections/dictionary.rs

@@ -289,7 +289,7 @@ impl Dictionary {
         /// Returns a 32-bit integer hash value representing the dictionary and its contents.
     }
 
-    #[deprecated = "renamed to hash_u32"]
+    #[deprecated = "renamed to `hash_u32`"]
     #[must_use]
     pub fn hash(&self) -> u32 {
         self.as_inner().hash().try_into().unwrap()

godot-core/src/builtin/mod.rs

@@ -118,7 +118,7 @@ pub mod inner {
 
 #[macro_export]
 macro_rules! declare_hash_u32_method {
-    ($ ($docs:tt)+ ) => {
+    ( $( $docs:tt )+ ) => {
         $( $docs )+
         pub fn hash_u32(&self) -> u32 {
             self.as_inner().hash().try_into().expect("Godot hashes are uint32_t")

godot-core/src/builtin/string/gstring.rs

@@ -160,7 +160,7 @@ impl GString {
         /// Returns a 32-bit integer hash value representing the string.
     }
 
-    #[deprecated = "renamed to hash_u32"]
+    #[deprecated = "renamed to `hash_u32`"]
     pub fn hash(&self) -> u32 {
         self.as_inner()
             .hash()

godot-core/src/builtin/string/node_path.rs

@@ -118,10 +118,10 @@ impl NodePath {
     }
 
     crate::declare_hash_u32_method! {
-        /// Returns a 32-bit integer hash value representing the string.
+        /// Returns a 32-bit integer hash value representing the node path.
     }
 
-    #[deprecated = "renamed to hash_u32"]
+    #[deprecated = "renamed to `hash_u32`"]
     pub fn hash(&self) -> u32 {
         self.as_inner()
             .hash()