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

Don't show Style/Documentation for private_constant or similar methods #5831

Closed
AlexWayfer opened this issue Apr 26, 2018 · 3 comments
Closed

Comments

@AlexWayfer
Copy link
Contributor

Expected behavior

No offenses from Style/Documentation for modules with class and private_constant method.

Actual behavior

There is offense.

Steps to reproduce the problem

module Foo
  class Bar
  end

  private_constant :Bar
end

RuboCop version

$ rubocop -V
0.55.0 (using Parser 2.5.1.0, running on ruby 2.5.1 x86_64-linux)
@bquorning
Copy link
Contributor

I’d just add a :nodoc: comment…

module Foo # :nodoc:
  class Bar
  end

  private_constant :Bar
end

@Drenmi
Copy link
Collaborator

Drenmi commented Dec 4, 2018

I think this request is legitimate, however it is unlikely we will have time to work on it any time soon. Since the solution suggested by @bquorning seems like a very reasonable fix, I will close this issue to reduce noise in the tracker. Feel free to open a PR to fix this if keen. 🙇

@Drenmi Drenmi closed this as completed Dec 4, 2018
@AlexWayfer
Copy link
Contributor Author

it is unlikely we will have time to work on it any time soon

I think it's not a reason for issue closing. Issue is still here.

Since the solution suggested by @bquorning seems like a very reasonable fix

It's work-around, not fix.

I will close this issue to reduce noise in the tracker

Please, use another tools for issues management. You can use projects or labels. But issue not resolved, so it should not be closed. Like… "help wanted" or something else, if you don't want to make this. But somebody might want.

I know, the closed issue can be found by search, but it's incorrect status for me anyway. And, I guess, for other people too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants