kotovalexarian-likes-gitlab/gitlab-org--gitlab-foss
1
0
Fork 0
Code Releases Activity

Make it clear that this is an acceptable use

Browse source
This commit is contained in:
Lin Jen-Shin 2017-11-22 16:34:52 +08:00
parent 89f2939525
commit 166a2d7a67
1 changed files with 8 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
doc/development/module_with_instance_variables.md
View file

@ -77,8 +77,7 @@ we could easily add to the cop, we should do it.
### How to rewrite and avoid disabling this cop
Even if we could just disable the cop, we should avoid doing so. Some code
could be easily rewritten in simple form. Here's an example. Consider this
acceptable method:
could be easily rewritten in simple form. Consider this acceptable method:
``` ruby
module Gitlab
@ -92,8 +91,12 @@ module Gitlab
end
```
It's still offending because it's not just `||=`, but we could split this
method into two:
This method is totally fine because it's already self-contained. No other
methods should be using `@emoji_unicode_versions_by_name` and we're good.
However it's still offending the cop because it's not just `||=`, and the
cop is not smart enough to judge that this is fine.
On the other hand, we could split this method into two:
``` ruby
module Gitlab
@ -112,7 +115,7 @@ module Gitlab
end
```
Now the cop won't complain. Here's another bad example which we could rewrite:
Now the cop won't complain. Here's a bad example which we could rewrite:
``` ruby
module SpamCheckService