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.

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 an error for Style/Documentation #11661

Merged
merged 1 commit into from
Mar 4, 2023

Conversation

koic
Copy link
Member

@koic koic commented Mar 4, 2023

This PR fixes an error for Style/Documentation when namespace is a variable.

m = Module.new
module n::N
  def method
  end
end
% rubocop documentation.rb --only Style/Documentation -d
(snip)

undefined method `namespace' for s(:lvar, :m):RuboCop::AST::Node
/Users/koic/src/github.com/rubocop/rubocop/lib/rubocop/cop/style/documentation.rb:187:in `qualify_const'
/Users/koic/src/github.com/rubocop/rubocop/lib/rubocop/cop/style/documentation.rb:187:in `qualify_const'
/Users/koic/src/github.com/rubocop/rubocop/lib/rubocop/cop/style/documentation.rb:181:in `block in identifier'

It also complements missing cbase and namespaces in offense messages. e.g.:

 class ::MyClass
-^^^^^^^^^^^^^^^ Missing top-level documentation comment for `class MyClass`.
+^^^^^^^^^^^^^^^ Missing top-level documentation comment for `class ::MyClass`.
 class self::MyClass
-^^^^^^^^^^^^^^^^^^^ Missing top-level documentation comment for `class MyClass`.
+^^^^^^^^^^^^^^^^^^^ Missing top-level documentation comment for `class self::MyClass`.
 class my_method::MyClass
-^^^^^^^^^^^^^^^^^^^^^^^^ Missing top-level documentation comment for `class MyClass`.
+^^^^^^^^^^^^^^^^^^^^^^^^ Missing top-level documentation comment for `class my_method::MyClass`.

Before submitting the PR make sure the following are checked:

  • The PR relates to only one subject with a clear title and description in grammatically correct, complete sentences.
  • Wrote good commit messages.
  • Commit message starts with [Fix #issue-number] (if the related issue exists).
  • Feature branch is up-to-date with master (if not - rebase it).
  • Squashed related commits together.
  • Added tests.
  • Ran bundle exec rake default. It executes all tests and runs RuboCop on its own code.
  • Added an entry (file) to the changelog folder named {change_type}_{change_description}.md if the new code introduces user-observable changes. See changelog entry format for details.

This PR fixes an error for `Style/Documentation`
when namespace is a variable.

```ruby
m = Module.new
module n::N
  def method
  end
end
```

```console
% rubocop documentation.rb --only Style/Documentation -d
(snip)

undefined method `namespace' for s(:lvar, :m):RuboCop::AST::Node
/Users/koic/src/github.com/rubocop/rubocop/lib/rubocop/cop/style/documentation.rb:187:in `qualify_const'
/Users/koic/src/github.com/rubocop/rubocop/lib/rubocop/cop/style/documentation.rb:187:in `qualify_const'
/Users/koic/src/github.com/rubocop/rubocop/lib/rubocop/cop/style/documentation.rb:181:in `block in identifier'
```

It also complements missing cbase and namespaces in offense messages. e.g.:

```diff
 class ::MyClass
-^^^^^^^^^^^^^^^ Missing top-level documentation comment for `class MyClass`.
+^^^^^^^^^^^^^^^ Missing top-level documentation comment for `class ::MyClass`.
```

```diff
 class self::MyClass
-^^^^^^^^^^^^^^^^^^^ Missing top-level documentation comment for `class MyClass`.
+^^^^^^^^^^^^^^^^^^^ Missing top-level documentation comment for `class self::MyClass`.
```

```diff
 class my_method::MyClass
-^^^^^^^^^^^^^^^^^^^^^^^^ Missing top-level documentation comment for `class MyClass`.
+^^^^^^^^^^^^^^^^^^^^^^^^ Missing top-level documentation comment for `class my_method::MyClass`.
```
@koic koic force-pushed the fix_an_error_for_style_documentation branch from d8e4701 to d2da4a4 Compare March 4, 2023 17:23
@bbatsov bbatsov merged commit 951507a into rubocop:master Mar 4, 2023
@bbatsov
Copy link
Collaborator

bbatsov commented Mar 4, 2023

Looks good. Thanks!

@koic koic deleted the fix_an_error_for_style_documentation branch March 5, 2023 01:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants