- 🇳🇿New Zealand quietone
This is a blocker for core issue, 📌 Prevent @file annotations from creeping back into the codebase Active
- 🇧🇪Belgium borisson_ Mechelen, 🇧🇪
So, the question here is whether we need a @file doc block for this class file. If so, what should it say? If not, we need a new/revised Coder rule to detect/fix/remove this doc block.
I don't think I've ever seen documentation that lives in @file that is useful. I think we need the coder rule to remove this docblock from all files, including test files.
- 🇳🇿New Zealand quietone
@borisson_, good point. There is an existing issue for that wider scope, #2655344: Please relax requirement for @file comment → . In that issue in comment #3 pfrenssen makes a case for having @file that is worth reading.
For this issue, I agree that an @file is of little value. And there is no need to change the @file docsumentation. → .
I think this is working as designed.
- 🇧🇪Belgium borisson_ Mechelen, 🇧🇪
I think this is working as designed.
I agree, will comment on the other issue.
- 🇳🇿New Zealand quietone
OK, then setting to RTBC so it should be discussed at the next meeting.
