Miretpl commented on code in PR #64980:
URL: https://github.com/apache/airflow/pull/64980#discussion_r3066897232


##########
chart/values.schema.json:
##########
@@ -2372,7 +2372,7 @@
                     }
                 },
                 "topologySpreadConstraints": {
-                    "description": "Specify topology spread constraints for 
Airflow Celery worker pods and pods created with pod-template-file.",
+                    "description": "Specify topology spread constraints for 
Airflow Celery worker pods and pods created with pod-template-file (deprecated, 
use ``workers.celery.topologySpreadConstraints`` and/or 
``workers.kubernetes.topologySpreadConstraints`` instead).",

Review Comment:
   > The schema description uses double backticks (...), which is 
reStructuredText-style and may render oddly/inconsistently in tooling that 
expects plain text/JSON Schema descriptions. Consider switching to single 
backticks (or no backticks) consistent with other schema descriptions in the 
chart
   
   Our docs render it correctly, so I'm leaving it as it is.
   
   > optionally add a JSON Schema deprecated: true marker for machine-readable 
deprecation.
   
   I'm planning to prepare a separate PR for it with proper addition to the 
documentation for users to have all deprecation information in one place in the 
doc.



-- 
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]

Reply via email to