john-bodley commented on pull request #17623: URL: https://github.com/apache/superset/pull/17623#issuecomment-991395136
@PApostol and @villebro beyond this change theres a cool PyLint extension [docparams](https://github.com/PyCQA/pylint/blob/main/pylint/extensions/docparams.rst) which ensures that params, returns, and exceptions are documented correctly. We use it on a number of projects at Airbnb and it's a great way to ensuring that functions are well documented and that the documentation is up to date. Without doubt the introduction of Mypy has removed some need for doc-strings however because: i) (sadly) Mypy doesn't handle exception typing, and ii) variable names may not contain sufficient detail, I sense there is still merit in having doc-params. -- 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]
