Explain purpose and usage.
This commit is contained in:
parent
6f8ff08c65
commit
04020d5e20
1 changed files with 24 additions and 0 deletions
|
@ -1,3 +1,27 @@
|
||||||
|
# == Participable concern
|
||||||
|
#
|
||||||
|
# Contains functionality related to objects that can have participants, such as
|
||||||
|
# an author, an assignee and people mentioned in its description or comments.
|
||||||
|
#
|
||||||
|
# Used by Issue, Note, MergeRequest, Snippet and Commit.
|
||||||
|
#
|
||||||
|
# Usage:
|
||||||
|
#
|
||||||
|
# class Issue < ActiveRecord::Base
|
||||||
|
# include Participable
|
||||||
|
#
|
||||||
|
# # ...
|
||||||
|
#
|
||||||
|
# participant :author, :assignee, :mentioned_users, :notes
|
||||||
|
# end
|
||||||
|
#
|
||||||
|
# issue = Issue.last
|
||||||
|
# users = issue.participants
|
||||||
|
# # `users` will contain the issue's author, its assignee,
|
||||||
|
# # all users returned by its #mentioned_users method,
|
||||||
|
# # as well as all participants to all of the issue's notes,
|
||||||
|
# # since Note implements Participable as well.
|
||||||
|
#
|
||||||
module Participable
|
module Participable
|
||||||
extend ActiveSupport::Concern
|
extend ActiveSupport::Concern
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue