Skip to content

Commit

Permalink
Slightly enhance documentation w.r.t suggestions given
Browse files Browse the repository at this point in the history
This basically does the 3 following things:
- Adds `# :nodoc:` for the three modules that doesn't need any
  documentation. Thanks to Antonio for this suggestion.
- It replaces the link to `cop.rb` file as a permalink so it
  doesn't get broken over time. Thanks to David for this suggestion.
- Paraphrases a line in README.md so as to *not* use the word "cop"
  as readers might not be familiar with the term.

Signed-off-by: Utkarsh Gupta <utkarsh@debian.org>
  • Loading branch information
utkarsh2102 committed Jun 16, 2020
1 parent a80a05e commit 46726c8
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 13 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
`RuboCop::Packaging` is an extension of [RuboCop](https://rubocop.org/),
which is a Ruby static code analyzer (a.k.a. linter) and code formatter.

It contains a set of Cops which enforces some of the guidelines that
are expected of upstream maintainers so that the downstream can build
their packages in a clean environment without any problems.
It helps enforcing some of the guidelines that are expected of upstream
maintainers so that the downstream can build their packages in a clean
environment without any problems.
Some of the other basic guidelines can be found
[here](https://wiki.debian.org/Teams/Ruby/RubyExtras/UpstreamDevelopers).

Expand Down
6 changes: 3 additions & 3 deletions docs/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
`RuboCop::Packaging` is an extension of [RuboCop](https://rubocop.org/),
which is a Ruby static code analyzer (a.k.a. linter) and code formatter.

It contains a set of Cops which enforces some of the guidelines that
are expected of upstream maintainers so that the downstream can build
their packages in a clean environment without any problems.
It helps enforcing some of the guidelines that are expected of upstream
maintainers so that the downstream can build their packages in a clean
environment without any problems.
Some of the other basic guidelines can be found
[here](https://wiki.debian.org/Teams/Ruby/RubyExtras/UpstreamDevelopers).
11 changes: 4 additions & 7 deletions lib/rubocop/cop/packaging/gemspec_git.rb
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@
# frozen_string_literal: true

# Rubocop module
module RuboCop
# Cop module
module Cop
# Packaging module
module Packaging
module RuboCop # :nodoc:
module Cop # :nodoc:
module Packaging # :nodoc:
# This cop is used to identify the usage of `git ls-files`
# and suggests to use a plain Ruby alternative, like `Dir`,
# `Dir.glob` or `Rake::FileList` instead.
Expand Down Expand Up @@ -68,7 +65,7 @@ class GemspecGit < Cop

# Extended from the Cop class.
# More about the `#investigate` method can be found here:
# https://github.com/rubocop-hq/rubocop/blob/master/lib/rubocop/cop/cop.rb
# https://github.com/rubocop-hq/rubocop/blob/59543c8e2b66bff249de131fa9105f3eb11e9edb/lib/rubocop/cop/cop.rb#L13-L25
#
# Processing of the AST happens here.
def investigate(processed_source)
Expand Down

0 comments on commit 46726c8

Please sign in to comment.