From 4237ccfb45a7b7709f56b05dc6b761638f5cab13 Mon Sep 17 00:00:00 2001
From: Philipp Maier <pmaier@sysmocom.de>
Date: Tue, 20 Dec 2022 11:21:47 +0100
Subject: [PATCH] pySim-prog: add python docstring for read_params_csv

Change-Id: I098ff56ef38208f2f321194625ff4279ece2023c
---
 pySim-prog.py | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/pySim-prog.py b/pySim-prog.py
index f106018f..b3919eee 100755
--- a/pySim-prog.py
+++ b/pySim-prog.py
@@ -584,6 +584,12 @@ def find_row_in_csv_file(csv_file_name:str, num=None, iccid=None, imsi=None):
 
 
 def read_params_csv(opts, imsi=None, iccid=None):
+    """
+    Read the card parameters from a CSV file. This function will generate the
+    same dictionary that gen_parameters would generate from parameters passed as
+    commandline arguments.
+    """
+
     row = find_row_in_csv_file(opts.read_csv, opts.num, iccid=iccid, imsi=imsi)
     if row is not None:
         row['mcc'] = row.get('mcc', mcc_from_imsi(row.get('imsi')))