Add more docstrings

Author: AlanCoding

ansible_base/lib/utils/db.py

@@ -177,12 +177,16 @@ def psycopg_kwargs_from_settings_dict(settings_dict: dj_db_dict) -> dict:
 
 
 def psycopg_conn_string_from_settings_dict(settings_dict: dj_db_dict) -> str:
+    """Returns a string that psycopg can take as conninfo for Connection class.
+
+    Example return value: "dbname=postgres user=postgres"
+    """
     conn_params = psycopg_kwargs_from_settings_dict(settings_dict)
     return psycopg.conninfo.make_conninfo(**conn_params)
 
 
 def combine_settings_dict(settings_dict1: dj_db_dict, settings_dict2: dj_db_dict, **extra_options) -> dj_db_dict:
-    """Given two Django settings dictionaries, combine them and return a new settings_dict"""
+    """Given two Django database settings dictionaries, combine them and return a new settings_dict"""
     settings_dict = deepcopy(settings_dict1)
     settings_dict['OPTIONS'] = deepcopy(settings_dict.get('OPTIONS', {}))
 
@@ -201,6 +205,12 @@ def combine_settings_dict(settings_dict1: dj_db_dict, settings_dict2: dj_db_dict
 
 
 def get_pg_notify_params(alias: str = DEFAULT_DB_ALIAS, **extra_options) -> dict:
+    """Returns a dictionary that can be used as kwargs to create a psycopg.Connection
+
+    This should use the same connection parameters as Django does.
+    However, this also allows overrides specified by the setting
+    PG_NOTIFY_DATABASES and then the LISTENER_DATABASES, deprecated AWX setting.
+    """
     pg_notify_overrides = {}
     if hasattr(settings, 'PG_NOTIFY_DATABASES'):
         pg_notify_overrides = settings.PG_NOTIFY_DATABASES.get(alias, {})