From 8356b86cad6b5d92a34f9e5de8bd1bcee6c358d6 Mon Sep 17 00:00:00 2001
From: Chris Salzberg <chris@dejimata.com>
Date: Fri, 24 Nov 2017 14:14:02 +0900
Subject: [PATCH] Add documentation

---
 .../plugins/active_record/attribute_methods.rb         |  6 ++++++
 lib/mobility/plugins/attribute_methods.rb              | 10 ++++++++++
 2 files changed, 16 insertions(+)

diff --git a/lib/mobility/plugins/active_record/attribute_methods.rb b/lib/mobility/plugins/active_record/attribute_methods.rb
index 1f6340936..e52bba715 100644
--- a/lib/mobility/plugins/active_record/attribute_methods.rb
+++ b/lib/mobility/plugins/active_record/attribute_methods.rb
@@ -1,5 +1,11 @@
 module Mobility
   module Plugins
+=begin
+
+Module builder adding translated attributes to #attributes hash on model
+instance. See {Mobility::Plugins::AttributeMethods} for further details.
+
+=end
     module ActiveRecord
       module TranslatedAttributes
         def translated_attributes
diff --git a/lib/mobility/plugins/attribute_methods.rb b/lib/mobility/plugins/attribute_methods.rb
index 0d8e60d8a..ec7f0b472 100644
--- a/lib/mobility/plugins/attribute_methods.rb
+++ b/lib/mobility/plugins/attribute_methods.rb
@@ -1,5 +1,15 @@
 module Mobility
   module Plugins
+=begin
+
+Adds translated attribute names and values to the hash returned by #attributes.
+Also adds a method #translated_attributes with names and values of translated
+attributes only.
+
+@note Adding translated attributes to #attributes can have unexpected
+  consequences, since these values are not true attribute values.
+
+=end
     module AttributeMethods
       class << self
         # Applies attribute_methods plugin for a given option value.