Skip to content

Commit

Permalink
Update cop documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
RobinDaugherty committed Apr 11, 2021
1 parent 0037c68 commit bb6f25e
Showing 1 changed file with 16 additions and 6 deletions.
22 changes: 16 additions & 6 deletions lib/rubocop/cop/bundler/gem_comment.rb
Expand Up @@ -3,15 +3,24 @@
module RuboCop
module Cop
module Bundler
# Add a comment describing each gem in your Gemfile.
# Each gem in the Gemfile should have a comment explaining
# its purpose in the project, or the reason for its version
# or source.
#
# Optionally, the "OnlyFor" configuration
# The optional "OnlyFor" configuration array
# can be used to only register offenses when the gems
# use certain options or have version specifiers.
# Add "version_specifiers" and/or the gem option names
# you want to check.
#
# A useful use-case is to enforce a comment when using
# When "version_specifiers" is included, a comment
# will be enforced if the gem has any version specifier.
#
# When "restrictive_version_specifiers" is included, a comment
# will be enforced if the gem has a version specifier that
# holds back the version of the gem.
#
# For any other value in the array, a comment will be enforced for
# a gem if an option by the same name is present.
# A useful use case is to enforce a comment when using
# options that change the source of a gem:
#
# - `bitbucket`
Expand All @@ -21,7 +30,8 @@ module Bundler
# - `source`
#
# For a full list of options supported by bundler,
# you can check the https://bundler.io/man/gemfile.5.html[official documentation].
# see https://bundler.io/man/gemfile.5.html
# .
#
# @example OnlyFor: [] (default)
# # bad
Expand Down

0 comments on commit bb6f25e

Please sign in to comment.