# Inch CI

ROM::Relation#combine

Parsed documentation:

Combine with other relations using configured associations

@overload combine(*associations)
  @example
    users.combine(:tasks, :posts)

  @param *associations [Array<Symbol>] A list of association names

@overload combine(*associations, **nested_associations)
  @example
    users.combine(:tasks, posts: :authors)

  @param *associations [Array<Symbol>] A list of association names
  @param *nested_associations [Hash] A hash with nested association names

@overload combine(associations)
  @example
    users.combine(posts: [:authors, reviews: [:tags, comments: :author])

  @param *associations [Hash] A hash with nested association names

@return [Relation]

@api public

Suggestions:

Describe what "combine" returns.
Describe the parameter "associations".
Describe the parameter "args".
Describe the parameter "nested_associations".

Please help! Open an issue on GitHub if this assessment is incorrect.

Inch CI evaluates your project's inline code documentation and reports grades for each class, module and method.

It is an open source project, created by René Föhring (@rrrene), based on Inch.

Please create an issue if anything seems broken or worthy of improvement.