added docstrings

bodealamu · Jul 3, 2021 · c613b91 · c613b91
1 parent e8be560
commit c613b91
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/graph_controls.py b/graph_controls.py
@@ -4,6 +4,14 @@
 
 
 def graph_controls(chart_type, df, dropdown_options, template):
+    """
+    Function which determines the widgets that would be shown for the different chart types
+    :param chart_type: str, name of chart
+    :param df: uploaded dataframe
+    :param dropdown_options: list of column names
+    :param template: str, representation of the selected theme
+    :return:
+    """
     length_of_options = len(dropdown_options)
     length_of_options -= 1
 

diff --git a/image_export.py b/image_export.py
@@ -5,6 +5,12 @@
 
 @st.cache
 def download_chart(plot, output_format):
+    """
+
+    :param plot: plotly figure
+    :param output_format: str, the required output format in string
+    :return:
+    """
 
     file_name_with_extension = 'image1' + output_format