docs: improve function docstring

Author: BryanttV

openedx/core/djangoapps/user_api/accounts/api.py

@@ -486,7 +486,9 @@ def _notify_language_proficiencies_update_if_needed(data, user, user_profile, ol
         )
 
 
-def _update_extended_profile_if_needed(data: dict, user_profile: UserProfile, custom_form: forms.Form) -> None:
+def _update_extended_profile_if_needed(
+    data: dict, user_profile: UserProfile, custom_form: Optional[forms.Form]
+) -> None:
     """
     Update the extended profile information if present in the data.
 
@@ -495,12 +497,10 @@ def _update_extended_profile_if_needed(data: dict, user_profile: UserProfile, cu
     2. Saves the custom form data to the extended profile model if valid
 
     Args:
-        data: Dictionary containing the update data, may include 'extended_profile' key
-        user_profile: The UserProfile instance to update
-        custom_form: The validated custom form containing extended profile data
-
-    Returns:
-        None
+        data (dict): Dictionary containing the update data, may include 'extended_profile' key
+        user_profile (UserProfile): The UserProfile instance to update
+        custom_form (Optional[forms.Form]): The validated custom form containing extended profile data,
+            or None if no custom form is provided
 
     Raises:
         None: All exceptions are handled internally with appropriate logging

openedx/core/djangoapps/user_api/accounts/serializers.py

@@ -578,7 +578,26 @@ def validate_new_name(self, new_name):
 
 def get_extended_profile(user_profile: UserProfile) -> list[dict[str, str]]:
     """
-    Returns the extended user profile fields stored in user_profile.meta
+    Retrieve extended user profile fields for API serialization.
+
+    This function extracts custom profile fields that extend beyond the standard
+    UserProfile model. It first attempts to get data from a custom extended profile
+    model (if configured), then falls back to the user_profile.meta JSON field.
+    The returned data is filtered to include only fields specified in the
+    'extended_profile_fields' site configuration.
+
+    The function supports two data sources:
+    1. Custom model: If REGISTRATION_EXTENSION_FORM setting points to a form with
+       a Meta.model, data is retrieved from that model using model_to_dict()
+    2. Fallback: JSON data stored in UserProfile.meta field
+
+    Args:
+        user_profile (UserProfile): The user profile instance to get extended fields from.
+
+    Returns:
+        list[dict[str, str]]: A list of dictionaries, each containing:
+            - 'field_name': The name of the extended profile field
+            - 'field_value': The value of the field (converted to string)
     """
     def get_extended_profile_data():
         extended_profile_model = get_extended_profile_model()