Merge pull request #19 from NicolasSoemer/master

Added a Docstring to __init__.py, to make the use of cfg more intuitive
kroitor · May 12, 2019 · 06d1ef0 · 06d1ef0
2 parents 9212b53 + aec20b9
commit 06d1ef0
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/asciichartpy/__init__.py b/asciichartpy/__init__.py
@@ -15,7 +15,10 @@
 # -----------------------------------------------------------------------------
 
 def plot(series, cfg={}):
-
+    """ Possible cfg parameters are 'offset', 'padding', 'height' and 'format'.
+	cfg is a dictionary, thus dictionary syntax has to be used.
+	Example: print(plot(series, { 'height' :10 })) 
+	"""
     minimum = cfg['minimum'] if 'minimum' in cfg else min(series)
     maximum = cfg['maximum'] if 'maximum' in cfg else max(series)