[GitHub] [dolphinscheduler] zhongjiajie opened a new issue, #11418: [Feature][python] Enforce all class and function param into doctoring

[GitBox <gi...@apache.org>]

zhongjiajie opened a new issue, #11418:
URL: https://github.com/apache/dolphinscheduler/issues/11418

   ### Search before asking
   
   - [X] I had searched in the [issues](https://github.com/apache/dolphinscheduler/issues?q=is%3Aissue) 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:
   1. Find a way to detective the class or function with missing docstring parameter, and add it to CI
   2. Fix some missing parameter desc for exists class and function
   3. 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](https://www.apache.org/foundation/policies/conduct)
   


-- 
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: commits-unsubscribe@dolphinscheduler.apache.org.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [dolphinscheduler] github-actions[bot] commented on issue #11418: [Feature][python] Enforce all class and function param into doctoring

[GitBox <gi...@apache.org>]

github-actions[bot] commented on issue #11418:
URL: https://github.com/apache/dolphinscheduler/issues/11418#issuecomment-1211590116

   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](https://s.apache.org/dolphinscheduler-slack) and send your question to channel `#troubleshooting`


-- 
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: commits-unsubscribe@dolphinscheduler.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org