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

DocumentationMethod cop should optionally apply to non-public methods #3360

Closed
qnm opened this issue Aug 1, 2016 · 0 comments
Closed

DocumentationMethod cop should optionally apply to non-public methods #3360

qnm opened this issue Aug 1, 2016 · 0 comments

Comments

@qnm
Copy link

qnm commented Aug 1, 2016

Expected behavior

The change in 723aa38 is very welcome, however in my case it only solves half of my issue.

The coding standard I work with mandates comments (YARDDOC) on all methods.

Can I propose a switch to 723aa38 which will allow the Cop to apply to methods of any visibility?

RuboCop version

Include the output of rubocop -V:

$ rubocop -V
0.42.0.pre

My team uses a gem packaged from the current master branch. There's too much good stuff in there 👯

Drenmi added a commit to Drenmi/rubocop that referenced this issue Aug 8, 2016
…non-public methods

This change allows the cop to be configured to also apply to non-public methods
using:

```
RequireForNonPublicMethods: true
```

It also makes the cop highlight the entire method definition, rather than just
the `def` keyword.
@bbatsov bbatsov closed this as completed in f915438 Aug 9, 2016
Neodelf pushed a commit to Neodelf/rubocop that referenced this issue Oct 15, 2016
…non-public methods (rubocop#3378)

This change allows the cop to be configured to also apply to non-public methods
using:

```
RequireForNonPublicMethods: true
```

It also makes the cop highlight the entire method definition, rather than just
the `def` keyword.
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

No branches or pull requests

1 participant