From a78203dc2b3fd1790c865a20177e618d037776e5 Mon Sep 17 00:00:00 2001
From: kxrd <onyeabor@riseup.net>
Date: Sat, 10 Jun 2017 21:22:18 +0200
Subject: [PATCH] Improve function parse_requirements docstring

---
 pipreqs/pipreqs.py | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/pipreqs/pipreqs.py b/pipreqs/pipreqs.py
index 01f8c7d..431764a 100755
--- a/pipreqs/pipreqs.py
+++ b/pipreqs/pipreqs.py
@@ -225,6 +225,10 @@ def join(f):
 def parse_requirements(file_):
     """Parse a requirements formatted file.
 
+    Traverse a string until a delimiter is detected, then split at said
+    delimiter, get module name by element index, create a dict consisting of
+    module:version, and add dict to list of parsed modules.
+
     Args:
         file_: File to parse.