Document Exchange

.rubocop_todo.yml

@@ -120,11 +120,6 @@ Naming/AccessorMethodName:
     - 'spec/support/request/shop_workflow.rb'
     - 'spec/support/request/web_helper.rb'
 
-# Offense count: 1
-Naming/BinaryOperatorParameterName:
-  Exclude:
-    - 'app/models/exchange.rb'
-
 # Offense count: 1
 # Configuration parameters: Blacklist.
 # Blacklist: (?-mix:(^|\s)(EO[A-Z]{1}|END)(\s|$))
@@ -173,7 +168,6 @@ Naming/UncommunicativeMethodParamName:
     - 'app/helpers/admin/injection_helper.rb'
     - 'app/helpers/spree/admin/base_helper_decorator.rb'
     - 'app/helpers/spree/base_helper_decorator.rb'
-    - 'app/models/exchange.rb'
     - 'app/services/subscription_validator.rb'
     - 'lib/open_food_network/reports/bulk_coop_report.rb'
     - 'lib/open_food_network/xero_invoices_report.rb'

app/models/exchange.rb

@@ -1,3 +1,12 @@
+# Representation of an enterprise being part of an order cycle.
+#
+# A producer can be part as supplier. The supplier's products can be selected to
+# be available in the order cycle (incoming products).
+#
+# A selling enterprise can be part as distributor. The order cycle then appears
+# in its shopfront. Any incoming product can be selected to be shown in the
+# shopfront (outgoing products). But the set of shown products can be smaller
+# than all incoming products.
 class Exchange < ActiveRecord::Base
   acts_as_taggable