More docs

Author: tyt2y3

sea-orm-macros/src/derives/active_model_ex.rs

@@ -97,6 +97,7 @@ pub fn expand_derive_active_model_ex(
                                             .push((ident.clone(), relation_enum.clone()));
                                     }
                                 } else if *entity_count.get(entity_path).unwrap() == 1 {
+                                    // can only Related to another Entity once
                                     if compound_attrs.belongs_to.is_some() {
                                         belongs_to_fields.push(ident.clone());
                                     } else if compound_attrs.has_one.is_some() {
@@ -118,6 +119,7 @@ pub fn expand_derive_active_model_ex(
                                     && compound_attrs.via.is_some()
                                     && compound_attrs.reverse.is_none()
                                 {
+                                    #[allow(clippy::unnecessary_unwrap)]
                                     has_many_via_self_fields.push((
                                         ident.clone(),
                                         compound_attrs.via.as_ref().unwrap().value(),
@@ -127,6 +129,7 @@ pub fn expand_derive_active_model_ex(
                                     && compound_attrs.via.is_some()
                                     && compound_attrs.reverse.is_some()
                                 {
+                                    #[allow(clippy::unnecessary_unwrap)]
                                     has_many_via_self_fields.push((
                                         ident.clone(),
                                         compound_attrs.via.as_ref().unwrap().value(),
@@ -381,6 +384,7 @@ fn expand_active_model_action(
         let relation_enum = Ident::new(&relation_enum.value(), relation_enum.span());
         let relation_enum = quote!(Relation::#relation_enum);
 
+        // belongs to is the exception where action is performed before self
         belongs_to_action.extend(quote! {
             let #field = if let Some(model) = self.#field.take() {
                 if model.is_update() {

sea-orm-macros/src/derives/model_ex.rs

@@ -448,6 +448,8 @@ fn relation_enum_variant(attr: &compound_attr::SeaOrm, ty: &str) -> Option<Token
         && ty.starts_with("HasMany<")
     {
         let has_many = Ident::new("has_many", Span::call_site());
+
+        #[allow(clippy::unnecessary_unwrap)]
         let via_rel = format!(
             "Relation::{}",
             attr.relation_reverse.as_ref().unwrap().value()

src/entity/active_model.rs

@@ -757,6 +757,7 @@ pub trait ActiveModelTrait: Clone + Debug {
         Self::Entity::find_related().belongs_to_active_model(self)
     }
 
+    /// Like find_related, but infer type from `AM`
     #[doc(hidden)]
     fn find_related_of<AM>(&self, _: &[AM]) -> crate::query::Select<AM::Entity>
     where
@@ -790,6 +791,7 @@ pub trait ActiveModelTrait: Clone + Debug {
         establish_links::<_, J, _, C>(self, related_models, left, right, delete_leftover, db).await
     }
 
+    /// Establish links for self-referencing many-to-many relation
     #[doc(hidden)]
     async fn establish_links_self<J, RM, C>(
         &self,
@@ -812,6 +814,7 @@ pub trait ActiveModelTrait: Clone + Debug {
         establish_links::<_, J, _, C>(self, related_models, left, right, delete_leftover, db).await
     }
 
+    /// Establish links for self-referencing many-to-many relation, but left-right reversed
     #[doc(hidden)]
     async fn establish_links_self_rev<J, RM, C>(
         &self,
@@ -834,6 +837,7 @@ pub trait ActiveModelTrait: Clone + Debug {
         establish_links::<_, J, _, C>(self, related_models, left, right, delete_leftover, db).await
     }
 
+    /// Inverse of establish link, break links between two many-to-many models
     #[doc(hidden)]
     async fn delete_links<J, C>(&self, _: J, db: &C) -> Result<DeleteResult, DbErr>
     where
@@ -857,6 +861,7 @@ pub trait ActiveModelTrait: Clone + Debug {
             .await
     }
 
+    /// Like `delete_links` but for self-referencing relations
     #[doc(hidden)]
     async fn delete_links_self<J, C>(&self, _: J, db: &C) -> Result<DeleteResult, DbErr>
     where

src/query/util.rs

@@ -144,7 +144,8 @@ where
     Ok(true)
 }
 
-/// construct a WHERE col IN (..) condition
+/// Constructs a `WHERE (c1, c2, ...) IN ((v11, v12, ...), (v21, v22, ...), ...)` expression.
+/// Degenerates to `WHERE col IN (v1, v2, ...)` when arity = 1.
 pub fn column_tuple_in_condition(
     table: &TableRef,
     to: &Identity,