Fix broken docs

Author: rnarubin

src/backends/googlepubsub/consumer.rs

@@ -27,7 +27,7 @@ use super::{
 /// A PubSub subscription name.
 ///
 /// This will be used to internally construct the expected
-/// `projects/{project}/subscriptions/hedwig-{queue}-{subscription}` format for API calls
+/// `projects/{project}/subscriptions/hedwig-{queue}-{subscription_name}` format for API calls
 #[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
 pub struct SubscriptionName<'s>(Cow<'s, str>);
 

src/backends/googlepubsub/mod.rs

@@ -43,14 +43,14 @@ macro_rules! match_fields {
         // nested cfg_attr prevents older compilers from parsing the new doc = EXPR syntax
         #[cfg_attr(docsrs, cfg_attr(docsrs,
             doc = "", // newline
-            doc = concat!("This is a more ergonomic wrapper over [`", stringify!($target), "`]")
+            doc = concat!("This is a more ergonomic wrapper over [`", match_fields!(@stringify_path $target), "`]")
         ))]
         #[cfg_attr(not(docsrs), allow(missing_docs))]
         pub struct $struct_name $(<$struct_generics>)? {
             $(
                 #[cfg_attr(docsrs, cfg_attr(docsrs, doc = concat!(
                     "See [`", stringify!($field_name), "`]",
-                    "(", stringify!($target), "::", stringify!($field_name), ")"
+                    "(", match_fields!(@stringify_path $target::$field_name), ")"
                 )))]
                 $(#[$field_attr])*
                 pub $field_name : $field_type,
@@ -72,7 +72,14 @@ macro_rules! match_fields {
                 };
             };
         }
-    }
+    };
+
+    // directly calling `stringify!` on a path will put spaces inbetween the :: separators, which
+    // then breaks doc linking.
+    // For whatever reason (expansion order maybe?), a macro indirection makes the path space-less
+    (@stringify_path $p:path) => {
+        stringify!($p)
+    };
 }
 
 mod consumer;

src/backends/mock.rs

@@ -16,6 +16,7 @@ use std::{
     task::{Context, Poll},
 };
 
+/// Errors originating from mock publisher and consumer operations
 #[derive(Debug, thiserror::Error)]
 #[error("{reason}")]
 pub struct Error {