dolphinscheduler
dolphinscheduler copied to clipboard
[Feature][python] Enforce all class and function param into doctoring
Search before asking
- [X] I had searched in the issues and found no similar feature requirement.
Description
some of our class and function with parameter but do not desc the parameter means, such as https://github.com/apache/dolphinscheduler/blob/16134014f83ac5196ded78885f1405b2e694ef5b/dolphinscheduler-python/pydolphinscheduler/src/pydolphinscheduler/core/process_definition.py#L54-L69, I think we should:
- Find a way to detective the class or function with missing docstring parameter, and add it to CI
- Fix some missing parameter desc for exists class and function
- Enforce all new adding class and function have parameter doctring
Use case
No response
Related issues
No response
Are you willing to submit a PR?
- [ ] Yes I am willing to submit a PR!
Code of Conduct
- [X] I agree to follow this project's Code of Conduct
Thank you for your feedback, we have received your issue, Please wait patiently for a reply.
- In order for us to understand your request as soon as possible, please provide detailed information、version or pictures.
- If you haven't received a reply for a long time, you can join our slack and send your question to channel
#troubleshooting