Skip to content

Commit 1c5d889

Browse files
update doc string
1 parent 47447c6 commit 1c5d889

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

nisystemlink/clients/product/utilities/_dataframe_utilities.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,13 @@ def convert_products_to_dataframe(products: List[Product]) -> DataFrame:
1212
products (List[Product]): A list of product responses retrieved from the API.
1313
1414
Returns:
15-
DataFrame: A Pandas DataFrame containing the normalized product data.
15+
DataFrame:
16+
- A Pandas DataFrame containing the normalized product data. The DataFrame would consist
17+
of all the fields received from the product response.
18+
19+
- Further, the properties field alone would get normalized. In the sense, there
20+
would be separate columns for each of the properties in the list of all products. The
21+
normalized column headers would be in the format `properties.property_name`.
1622
"""
1723
products_dict_representation = [product.dict() for product in products]
1824
normalized_products_dataframe = pd.json_normalize(

0 commit comments

Comments
 (0)