potiuk commented on issue #342:
URL:
https://github.com/apache/tooling-trusted-releases/issues/342#issuecomment-3567041414
good idea. This should be somehow transparent - and ideally documented
automatically out of the docsstrings in the code. Ideally, every check
implemented should implemetn some prototype or extend a class, and the
docsttring on that particular check should describe what it does, also those
classes should have a lint check to make sure they are well documented
(including like minimum size of the docstring - I know it's a terrible measure
but it might filter out some simple things like auto-generated non-helpful docs
like the famous java docs:
```python
def paint():
"paints the screen"
def repaint():
"repaints the screen"
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
