From 6a93b6e8367ebec3373059e52d2210f606065c9c Mon Sep 17 00:00:00 2001 From: Cyril Duchon-Doris Date: Sat, 8 Jun 2019 14:40:58 +0200 Subject: [PATCH] Update the documentation --- lib/mongoid/history/attributes/update.rb | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/lib/mongoid/history/attributes/update.rb b/lib/mongoid/history/attributes/update.rb index 0b9ce33d..2b4dabce 100644 --- a/lib/mongoid/history/attributes/update.rb +++ b/lib/mongoid/history/attributes/update.rb @@ -6,13 +6,11 @@ class Update < ::Mongoid::History::Attributes::Base # # { # 'foo' => ['foo_before_changes', 'foo_after_changes'] - # 'nested_bar' => { - # 'baz' => ['nested_bar_baz_before_changes', 'nested_bar_baz_after_changes'] + # 'nested_bar.baz' => ['nested_bar_baz_before_changes', 'nested_bar_baz_after_changes'] # } # } # - # @return [Hash] Hash of changes - # ? can be either a pair or a hash for embedded documents + # @return [Hash>] Hash of changes def attributes changes_from_parent.deep_merge(changes_from_children) end @@ -44,7 +42,7 @@ def changes_from_children # # {"child"=>{"name"=>["todd", "mario"]}} # - # @return [Hash] changes of embeds_ones from embedded documents + # @return [Hash] changes of embeds_ones from embedded documents def embeds_one_changes_from_embedded_documents embedded_doc_changes = {} trackable_class.tracked_embeds_one.each do |rel| @@ -61,8 +59,8 @@ def embeds_one_changes_from_embedded_documents embedded_doc_changes end - # @param [String] relation - # @param [String] value + # @param [String] relation + # @param [String] value # # @return [Hash>] def embeds_one_changes_from_parent(relation, value) @@ -76,8 +74,8 @@ def embeds_one_changes_from_parent(relation, value) { relation => [original_value, modified_value] } end - # @param [String] relation - # @param [String] value + # @param [String] relation + # @param [String] value # # @return [Hash>] def embeds_many_changes_from_parent(relation, value)