From acd4dddf1b008fcde64daa0cbf9137f0556513e3 Mon Sep 17 00:00:00 2001
From: Pau Perez <saulopefa@gmail.com>
Date: Mon, 11 Jan 2021 16:53:52 +0100
Subject: [PATCH] Doc how balance_value works

[skip ci]
---
 app/serializers/api/admin/customer_with_balance_serializer.rb | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/app/serializers/api/admin/customer_with_balance_serializer.rb b/app/serializers/api/admin/customer_with_balance_serializer.rb
index dfbb088991..fb043dda76 100644
--- a/app/serializers/api/admin/customer_with_balance_serializer.rb
+++ b/app/serializers/api/admin/customer_with_balance_serializer.rb
@@ -2,6 +2,10 @@
 
 module Api
   module Admin
+    # This serializer relies on `object` to respond to `#balance_value`. That's done in
+    # `CustomersWithBalance` due to the fact that ActiveRecord maps the DB result set's columns to
+    # instance methods. This way, the `balance_value` alias on that class ends up being
+    # `object.balance_value` here.
     class CustomerWithBalanceSerializer < CustomerSerializer
       attributes :balance, :balance_status