Add DocStrings and update Readme > grocery-shopping

Author: rjLelis

grocery-shopping/README.md

@@ -1,8 +1,9 @@
 # Grocery shopping
 
-Store grocery items in a `.data` file
+Stores grocery items in a `.data` file
 
 ### Worked concepts
 * File reading and writing
 * Pickle
-* Lists
+* Lists
+* Doc strings

grocery-shopping/grocery_list_repository.py

@@ -5,11 +5,13 @@
 
 
 def persist(items):
+    '''stores a list in a file'''
     with open(file, "wb") as f:
         pickle.dump(items, f)
 
 
 def read():
+    '''get all items and returns a list'''
     items = []
     if file.is_file():
         with open(file, "rb") as f:
@@ -18,6 +20,7 @@ def read():
 
 
 def delete(item):
+    '''deletes a item from the list and updates de file'''
     items = read()
     items.remove(item)
     with open(file, "r+b") as f:

grocery-shopping/main.py

@@ -40,6 +40,7 @@ def main():
         print("0 - Exit")
         option = options(int(input("> ")))
         if option == 1:
+            print('Exiting program')
             break