[airflow] branch main updated: Extends resolve_xcom_backend function level documentation (#24965)

[ba...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

basph pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git


The following commit(s) were added to refs/heads/main by this push:
     new 178af9d247 Extends resolve_xcom_backend function level documentation (#24965)
178af9d247 is described below

commit 178af9d24772a8866ac55d25eeb48bed77337031
Author: Frank Cash <fc...@astronomer.io>
AuthorDate: Mon Jul 11 14:10:30 2022 -0400

    Extends resolve_xcom_backend function level documentation (#24965)
    
    * # This is a combination of 2 commits.
    # This is the 1st commit message:
    
    Extends resolve_xcom_backend documentation
    # This is the commit message #2:
    
    properly stylize XCom
    
    * Extends resolve_xcom_backend documentation
    
    properly stylize XCom
    
    Final docstring update
    
    Extends resolve_xcom_backend documentation
    
    properly stylize XCom
    
    Final docstring update
    
    * Stylistic changes
---
 airflow/models/xcom.py | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/airflow/models/xcom.py b/airflow/models/xcom.py
index 146e67269f..2d5528ca0b 100644
--- a/airflow/models/xcom.py
+++ b/airflow/models/xcom.py
@@ -658,7 +658,11 @@ def _get_function_params(function) -> List[str]:
 
 
 def resolve_xcom_backend() -> Type[BaseXCom]:
-    """Resolves custom XCom class"""
+    """Resolves custom XCom class
+
+    Confirms that custom XCom class extends the BaseXCom.
+    Compares the function signature of the custom XCom serialize_value to the base XCom serialize_value.
+    """
     clazz = conf.getimport("core", "xcom_backend", fallback=f"airflow.models.xcom.{BaseXCom.__name__}")
     if not clazz:
         return BaseXCom