Github user zentol commented on the issue:
https://github.com/apache/flink/pull/3833
I think it is intended. The majority of tests can be (and are) commented
with "Tests for the {@link <classToTest>}.", which is totally OK because it
tells us that this is the general test battery for that class and not something
else. These are also easy to add so there's not a real overhead in doing so.
But this doesn't apply to all of them; and you only really notice the
missing javadoc when you stumble on a test and you spend 10 minutes trying to
figure out what it is doing because the method names aren't helping at all.
The widely-accepted notion that the name of a class and test method are
supposed to be enough documentation for test is quite questionable IMO; and by
enforcing a javadoc on the class we give a little nudge to make the developer
hopefully think about whether something needs to be documented or not.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---
