Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix YARD documentation for class methods #1831

Merged
merged 1 commit into from
Mar 12, 2024
Merged

Fix YARD documentation for class methods #1831

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 33 additions & 22 deletions lib/rubocop/cop/rspec/rails/minitest_assertions.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,9 @@ class EqualAssertion < BasicAssertion
refute_equal
].freeze

# @!method self.minitest_assertion(node)
def_node_matcher 'self.minitest_assertion', <<~PATTERN # rubocop:disable InternalAffairs/NodeMatcherDirective
# @!method minitest_assertion(node)
# @!scope class
def_node_matcher 'self.minitest_assertion', <<~PATTERN
(send nil? {:assert_equal :assert_not_equal :refute_equal} $_ $_ $_?)
PATTERN

Expand All @@ -97,8 +98,9 @@ class KindOfAssertion < BasicAssertion
refute_kind_of
].freeze

# @!method self.minitest_assertion(node)
def_node_matcher 'self.minitest_assertion', <<~PATTERN # rubocop:disable InternalAffairs/NodeMatcherDirective
# @!method minitest_assertion(node)
# @!scope class
def_node_matcher 'self.minitest_assertion', <<~PATTERN
(send nil? {:assert_kind_of :assert_not_kind_of :refute_kind_of} $_ $_ $_?)
PATTERN

Expand All @@ -119,8 +121,9 @@ class InstanceOfAssertion < BasicAssertion
refute_instance_of
].freeze

# @!method self.minitest_assertion(node)
def_node_matcher 'self.minitest_assertion', <<~PATTERN # rubocop:disable InternalAffairs/NodeMatcherDirective
# @!method minitest_assertion(node)
# @!scope class
def_node_matcher 'self.minitest_assertion', <<~PATTERN
(send nil? {:assert_instance_of :assert_not_instance_of :refute_instance_of} $_ $_ $_?)
PATTERN

Expand All @@ -141,8 +144,9 @@ class IncludesAssertion < BasicAssertion
refute_includes
].freeze

# @!method self.minitest_assertion(node)
def_node_matcher 'self.minitest_assertion', <<~PATTERN # rubocop:disable InternalAffairs/NodeMatcherDirective
# @!method minitest_assertion(node)
# @!scope class
def_node_matcher 'self.minitest_assertion', <<~PATTERN
(send nil? {:assert_includes :assert_not_includes :refute_includes} $_ $_ $_?)
PATTERN

Expand All @@ -163,8 +167,9 @@ class InDeltaAssertion < BasicAssertion
refute_in_delta
].freeze

# @!method self.minitest_assertion(node)
def_node_matcher 'self.minitest_assertion', <<~PATTERN # rubocop:disable InternalAffairs/NodeMatcherDirective
# @!method minitest_assertion(node)
# @!scope class
def_node_matcher 'self.minitest_assertion', <<~PATTERN
(send nil? {:assert_in_delta :assert_not_in_delta :refute_in_delta} $_ $_ $_? $_?)
PATTERN

Expand All @@ -191,8 +196,9 @@ class PredicateAssertion < BasicAssertion
refute_predicate
].freeze

# @!method self.minitest_assertion(node)
def_node_matcher 'self.minitest_assertion', <<~PATTERN # rubocop:disable InternalAffairs/NodeMatcherDirective
# @!method minitest_assertion(node)
# @!scope class
def_node_matcher 'self.minitest_assertion', <<~PATTERN
(send nil? {:assert_predicate :assert_not_predicate :refute_predicate} $_ ${sym} $_?)
PATTERN

Expand All @@ -214,8 +220,9 @@ class MatchAssertion < BasicAssertion
refute_match
].freeze

# @!method self.minitest_assertion(node)
def_node_matcher 'self.minitest_assertion', <<~PATTERN # rubocop:disable InternalAffairs/NodeMatcherDirective
# @!method minitest_assertion(node)
# @!scope class
def_node_matcher 'self.minitest_assertion', <<~PATTERN
(send nil? {:assert_match :refute_match} $_ $_ $_?)
PATTERN

Expand All @@ -236,8 +243,9 @@ class NilAssertion < BasicAssertion
refute_nil
].freeze

# @!method self.minitest_assertion(node)
def_node_matcher 'self.minitest_assertion', <<~PATTERN # rubocop:disable InternalAffairs/NodeMatcherDirective
# @!method minitest_assertion(node)
# @!scope class
def_node_matcher 'self.minitest_assertion', <<~PATTERN
(send nil? {:assert_nil :assert_not_nil :refute_nil} $_ $_?)
PATTERN

Expand All @@ -258,8 +266,9 @@ class EmptyAssertion < BasicAssertion
refute_empty
].freeze

# @!method self.minitest_assertion(node)
def_node_matcher 'self.minitest_assertion', <<~PATTERN # rubocop:disable InternalAffairs/NodeMatcherDirective
# @!method minitest_assertion(node)
# @!scope class
def_node_matcher 'self.minitest_assertion', <<~PATTERN
(send nil? {:assert_empty :assert_not_empty :refute_empty} $_ $_?)
PATTERN

Expand All @@ -278,8 +287,9 @@ class TrueAssertion < BasicAssertion
assert_true
].freeze

# @!method self.minitest_assertion(node)
def_node_matcher 'self.minitest_assertion', <<~PATTERN # rubocop:disable InternalAffairs/NodeMatcherDirective
# @!method minitest_assertion(node)
# @!scope class
def_node_matcher 'self.minitest_assertion', <<~PATTERN
(send nil? {:assert_true} $_ $_?)
PATTERN

Expand All @@ -298,8 +308,9 @@ class FalseAssertion < BasicAssertion
assert_false
].freeze

# @!method self.minitest_assertion(node)
def_node_matcher 'self.minitest_assertion', <<~PATTERN # rubocop:disable InternalAffairs/NodeMatcherDirective
# @!method minitest_assertion(node)
# @!scope class
def_node_matcher 'self.minitest_assertion', <<~PATTERN
(send nil? {:assert_false} $_ $_?)
PATTERN

Expand Down