Skip to content

Commit a9dc5f4

Browse files
author
Nikolay Kasyanov
committed
Updates plugin doc comment
1 parent 9fd5e71 commit a9dc5f4

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

lib/code_style_validation/plugin.rb

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,22 @@ module Danger
77
#
88
# @example Ensure that added lines does not violate code style
99
#
10-
# code-style-validation.check
10+
# code_style_validation.check
1111
#
1212
# @example Ensure that changes don't violate code style, ignoring Pods directory
1313
#
1414
# code_style_validation.check ignore_file_patterns: [/^Pods\//]
1515
#
16-
# @see Ersen Tekin/danger-code_style_validation
17-
# @tags code, style, violation, validation
16+
# @see danger/danger
17+
# @tags code style, validation
1818
#
1919
class DangerCodeStyleValidation < Plugin
2020
VIOLATION_ERROR_MESSAGE = 'Code style violations detected.'.freeze
2121

22+
# Validates the code style of changed & added files using clang-format.
23+
# Generates Markdown message with respective patches.
24+
#
25+
# @return [void]
2226
def check(config = {})
2327
ignore_file_patterns = [*config[:ignore_file_patterns]]
2428

0 commit comments

Comments
 (0)