Basic docs for most classes

1 files changed, 7 insertions, 0 deletions

diff --git a/app/models/action_mailbox/inbound_email/routable.rb b/app/models/action_mailbox/inbound_email/routable.rb
index 8f5b0ddd39..f042fa4f57 100644
--- a/app/models/action_mailbox/inbound_email/routable.rb
+++ b/app/models/action_mailbox/inbound_email/routable.rb
@@ -1,3 +1,8 @@
+# A newly received `InboundEmail` will not be routed synchronously as part of ingress controller's receival.
+# Instead, the routing will be done asynchronously, using a `RoutingJob`, to ensure maximum parallel capacity.
+#
+# By default, all newly created `InboundEmail` records that have the status of `pending`, which is the default,
+# will be scheduled for automatic, deferred routing.
 module ActionMailbox::InboundEmail::Routable
   extend ActiveSupport::Concern
 
@@ -5,10 +10,12 @@ module ActionMailbox::InboundEmail::Routable
     after_create_commit :route_later, if: :pending?
   end
 
+  # Enqueue a `RoutingJob` for this `InboundEmail`.
   def route_later
     ActionMailbox::RoutingJob.perform_later self
   end
 
+  # Route this `InboundEmail` using the routing rules declared on the `ApplicationMailbox`.
   def route
     ApplicationMailbox.route self
   end