search

troessner / reek

Code smell detector for Ruby
https://github.com/troessner/reek
MIT License
4.05k stars 280 forks source link

Revamp our /docs #1139

Closed troessner closed 6 years ago

troessner commented 8 years ago

Our /docs are good. I even think they are great. We put a lot thought into them and they are quite thorough. We're still missing bits and pieces here and there due to the complexity of the domain Reek covers. I'd like to go through all of them over the next days and document missing pieces that bubble up in issues like #1137 or #1058

I think that most if not all our smell detectors should have some configuration samples at the end. It is not much effort for us and it will make things so much easier for users. And yes, that would not be DRY at all. Sometimes DRY is bad and I feel that this is exactly one of those places.

troessner commented 6 years ago

I think we've done a lot for our documentation and it's an ongoing effort that will never really stop. Let's close this issue instead of having it hanging around forever.