[GitHub] [airflow] jedcunningham commented on a change in pull request #16442: Fix templated default/example values in config ref docs

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

jedcunningham commented on a change in pull request #16442:
URL: https://github.com/apache/airflow/pull/16442#discussion_r651948311



##########
File path: airflow/configuration.py
##########
@@ -92,7 +92,7 @@ def _default_config_file_path(file_name: str):
     return os.path.join(templates_dir, file_name)
 
 
-def default_config_yaml() -> dict:
+def default_config_yaml() -> List[dict]:

Review comment:
       Yeah, it is a list:
   https://github.com/apache/airflow/blob/main/airflow/config_templates/config.yml
   
   PyYAML is referring to YAML documents: https://pyyaml.org/wiki/PyYAMLDocumentation#documents
   
   We only have one, but you could have more than one in the steam, e.g:
   ```
   ---
   - a:b
   ---
   - c:d
   ```
   
   Interestingly, for me `safe_load` actually raises when it sees more than 1 document 🤷‍♂️




-- 
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:
users@infra.apache.org