Commit 077a1571 authored by Douwe Maan's avatar Douwe Maan Committed by Luke "Jared" Bennett

Add line breaks in long comments

parent 3ff708f7
...@@ -37,15 +37,17 @@ class Discussion ...@@ -37,15 +37,17 @@ class Discussion
[:discussion, note.noteable_type.try(:underscore), noteable_id] [:discussion, note.noteable_type.try(:underscore), noteable_id]
end 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, # 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 # 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 # individual notes on the commit with different discussion IDs, so that it's clear that these are not
# notes on the merge request itself. # 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 # `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 # 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`. # the `discussion_class` method on `Note` or a subclass of `Note`.
#
# If no override is necessary, return `nil`. # If no override is necessary, return `nil`.
# For the case described above, see `OutOfContextDiscussion.override_discussion_id`. # For the case described above, see `OutOfContextDiscussion.override_discussion_id`.
def self.override_discussion_id(note) def self.override_discussion_id(note)
......
# When notes on a commit are displayed in the context of a merge request that contains that commit, # When notes on a commit are displayed in the context of a merge request that
# they are displayed as if they were a discussion. # contains that commit, they are displayed as if they were a discussion.
#
# This represents one of those discussions, consisting of `Note` notes. # This represents one of those discussions, consisting of `Note` notes.
class OutOfContextDiscussion < Discussion class OutOfContextDiscussion < Discussion
# Returns an array of discussion ID components # Returns an array of discussion ID components
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment