refactor: rename private mod to __private (#31)

cot-rs · Sep 22, 2024 · 5027745 · 5027745
1 parent 7eb06ee
commit 5027745
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/flareon-macros/src/form.rs b/flareon-macros/src/form.rs
@@ -148,7 +148,7 @@ impl FormDeriveBuilder {
         let fields_as_from_context = &self.fields_as_from_context;
 
         quote! {
-            #[#crate_ident::private::async_trait]
+            #[#crate_ident::__private::async_trait]
             #[automatically_derived]
             impl #crate_ident::forms::Form for #name {
                 type Context = #context_struct_name;

diff --git a/flareon/src/lib.rs b/flareon/src/lib.rs
@@ -16,8 +16,10 @@ pub mod db;
 mod error;
 pub mod forms;
 mod headers;
+// Not public API. Referenced by macro-generated code.
 #[doc(hidden)]
-pub mod private;
+#[path = "private.rs"]
+pub mod __private;
 pub mod request;
 pub mod response;
 pub mod router;

diff --git a/flareon/src/private.rs b/flareon/src/private.rs
@@ -2,4 +2,6 @@
 //!
 //! This is to avoid the need to add them as dependencies to the crate that uses
 //! the macros.
+//!
+//! This is not a public API and should not be used directly.
 pub use async_trait::async_trait;