Mention serde impls explicitly in #[doc(cfg)]

This can be done even if `serde` feature is disabled during docs publishing, would just be no-op.
godot-rust · May 24, 2024 · 0a9c7fb · 0a9c7fb
1 parent 41ccbe8
commit 0a9c7fb
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 3 deletions.
diff --git a/godot-core/src/builtin/string/gstring.rs b/godot-core/src/builtin/string/gstring.rs
@@ -348,6 +348,8 @@ mod serialize {
     use serde::{Deserialize, Deserializer, Serialize, Serializer};
     use std::fmt::Formatter;
 
+    // For "Available on crate feature `serde`" in docs. Cannot be inherited from module. Also does not support #[derive] (e.g. in Vector2).
+    #[cfg_attr(published_docs, doc(cfg(feature = "serde")))]
     impl Serialize for GString {
         #[inline]
         fn serialize<S>(
@@ -361,8 +363,8 @@ mod serialize {
         }
     }
 
-    #[cfg(feature = "serde")]
-    impl<'de> serialize::Deserialize<'de> for GString {
+    #[cfg_attr(published_docs, doc(cfg(feature = "serde")))]
+    impl<'de> Deserialize<'de> for GString {
         #[inline]
         fn deserialize<D>(deserializer: D) -> Result<Self, <D as Deserializer<'de>>::Error>
         where

diff --git a/godot-core/src/builtin/string/node_path.rs b/godot-core/src/builtin/string/node_path.rs
@@ -159,6 +159,8 @@ mod serialize {
     use serde::{Deserialize, Deserializer, Serialize, Serializer};
     use std::fmt::Formatter;
 
+    // For "Available on crate feature `serde`" in docs. Cannot be inherited from module. Also does not support #[derive] (e.g. in Vector2).
+    #[cfg_attr(published_docs, doc(cfg(feature = "serde")))]
     impl Serialize for NodePath {
         #[inline]
         fn serialize<S>(
@@ -172,6 +174,7 @@ mod serialize {
         }
     }
 
+    #[cfg_attr(published_docs, doc(cfg(feature = "serde")))]
     impl<'de> Deserialize<'de> for NodePath {
         #[inline]
         fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

diff --git a/godot-core/src/builtin/string/string_name.rs b/godot-core/src/builtin/string/string_name.rs
@@ -365,6 +365,8 @@ mod serialize {
     use serde::{Deserialize, Deserializer, Serialize, Serializer};
     use std::fmt::Formatter;
 
+    // For "Available on crate feature `serde`" in docs. Cannot be inherited from module. Also does not support #[derive] (e.g. in Vector2).
+    #[cfg_attr(published_docs, doc(cfg(feature = "serde")))]
     impl Serialize for StringName {
         #[inline]
         fn serialize<S>(
@@ -378,7 +380,8 @@ mod serialize {
         }
     }
 
-    impl<'de> serialize::Deserialize<'de> for StringName {
+    #[cfg_attr(published_docs, doc(cfg(feature = "serde")))]
+    impl<'de> Deserialize<'de> for StringName {
         #[inline]
         fn deserialize<D>(deserializer: D) -> Result<Self, <D as Deserializer<'de>>::Error>
         where