X-Git-Url: https://git.openstreetmap.org/rails.git/blobdiff_plain/851de28303fc9c24d095b9452b862bea618ec0da..a6b84a0294a2929006ff056f56103be549c5b5a2:/app/models/redaction.rb

diff --git a/app/models/redaction.rb b/app/models/redaction.rb
index ca0ea7232..b3c5ec5ba 100644
--- a/app/models/redaction.rb
+++ b/app/models/redaction.rb
@@ -1,10 +1,10 @@
 ##
 # Redaction represents a record associated with a particular
 # action on the database to hide revisions from the history
-# which are not appropriate to redistribute any more. 
+# which are not appropriate to redistribute any more.
 #
 # The circumstances of the redaction can be recorded in the
-# record's title and description fields, which can be 
+# record's title and description fields, which can be
 # displayed linked from the redacted records.
 #
 class Redaction < ActiveRecord::Base
@@ -14,6 +14,8 @@ class Redaction < ActiveRecord::Base
   has_many :old_ways
   has_many :old_relations
 
+  # this method overrides the AR default to provide the rich
+  # text object for the description field.
   def description
     RichText.new(read_attribute(:description_format), read_attribute(:description))
   end