diff options
| -rw-r--r-- | app/models/discussion.rb | 6 | ||||
| -rw-r--r-- | app/models/out_of_context_discussion.rb | 5 |
2 files changed, 7 insertions, 4 deletions
diff --git a/app/models/discussion.rb b/app/models/discussion.rb index 22130b8a508..8268a140403 100644 --- a/app/models/discussion.rb +++ b/app/models/discussion.rb @@ -37,15 +37,17 @@ class Discussion [:discussion, note.noteable_type.try(:underscore), noteable_id] end - # To turn a list of notes into a list of discussions, they are grouped by discussion ID. # When notes on a commit are displayed in context of a merge request that contains that commit, # these notes are to be displayed as if they were part of one discussion, even though they were actually # individual notes on the commit with different discussion IDs, so that it's clear that these are not # notes on the merge request itself. - # To get these out-of-context notes to end up in the same discussion, we need to get them to return the same + # + # To turn a list of notes into a list of discussions, they are grouped by discussion ID, so to + # get these out-of-context notes to end up in the same discussion, we need to get them to return the same # `discussion_id` when this grouping happens. To enable this, `Note#discussion_id` calls out # to the `override_discussion_id` method on the appropriate `Discussion` subclass, as determined by # the `discussion_class` method on `Note` or a subclass of `Note`. + # # If no override is necessary, return `nil`. # For the case described above, see `OutOfContextDiscussion.override_discussion_id`. def self.override_discussion_id(note) diff --git a/app/models/out_of_context_discussion.rb b/app/models/out_of_context_discussion.rb index 62b62ea726c..31c6d5cff8b 100644 --- a/app/models/out_of_context_discussion.rb +++ b/app/models/out_of_context_discussion.rb @@ -1,5 +1,6 @@ -# When notes on a commit are displayed in the context of a merge request that contains that commit, -# they are displayed as if they were a discussion. +# When notes on a commit are displayed in the context of a merge request that +# contains that commit, they are displayed as if they were a discussion. +# # This represents one of those discussions, consisting of `Note` notes. class OutOfContextDiscussion < Discussion # Returns an array of discussion ID components |