davlum commented on a change in pull request #6230: [AIRFLOW-5413] Allow K8S
pod to be configured from JSON/YAML file
URL: https://github.com/apache/airflow/pull/6230#discussion_r331551757
##########
File path: airflow/kubernetes/pod_generator.py
##########
@@ -62,75 +68,53 @@ class PodGenerator:
Contains Kubernetes Airflow Worker configuration logic
Represents a kubernetes pod and manages execution of a single pod.
- :param image: The docker image
Review comment:
I found the docstring on the parameter level to be frequently incomplete
and/or inaccurate. The `:type` aspect in particular often conflicts with the
types that are guaranteed to be correct in the type annotations. It creates two
places where code needs to be updated, but with no static check to actually
guarantee that it has been done.
I realize that the standard is having the docstring for every parameter so I
will add it back, but I do feel that in some cases this is creating more
maintenance cost and bloat than value being added.
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
