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 #10234

Merged
merged 1 commit into from Nov 4, 2021

Conversation

koic
Copy link
Member

@koic koic commented Nov 4, 2021

This PR fixes the following error for Style/Documentation when using a cbase class.

% cat example.rb
class ::MyClass
  def method
  end
end
% bundle exec rubocop --only Style/Documentation -d
(snip)

An error occurred while Style/Documentation cop was inspecting
/Users/koic/src/github.com/koic/rubocop-issues/bar/example.rb:1:0.
undefined method `namespace' for s(:cbase):RuboCop::AST::Node
/Users/koic/src/github.com/rubocop/rubocop/lib/rubocop/cop/style/documentation.rb:181:in `qualify_const'

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 the following error for `Style/Documentation` when using a cbase class.

```ruby
% cat example.rb
class ::MyClass
  def method
  end
end
```

```console
% bundle exec rubocop --only Style/Documentation -d
(snip)

An error occurred while Style/Documentation cop was inspecting
/Users/koic/src/github.com/koic/rubocop-issues/bar/example.rb:1:0.
undefined method `namespace' for s(:cbase):RuboCop::AST::Node
/Users/koic/src/github.com/rubocop/rubocop/lib/rubocop/cop/style/documentation.rb:181:in `qualify_const'
```
@bbatsov bbatsov merged commit df440de into rubocop:master Nov 4, 2021
@bbatsov
Copy link
Collaborator

bbatsov commented Nov 4, 2021

Thanks!

@koic koic deleted the fix_error_for_style_documentation branch November 4, 2021 17:06
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