Updated Searching.rst

OmkarPathak · OmkarPathak · commit fd8b49290e6f · 2017-08-09T10:53:40.000+05:30
diff --git a/docs/Searching.rst b/docs/Searching.rst
@@ -30,8 +30,16 @@ Features
     - Breadth First Search (breadth_first_search)
     - Depth First Search (depth_first_search)
 
+* To see all the available functions in a module there is a `modules()` function available. For example,
+
+.. code:: python
+
+    >>> from pygorithm.searching import modules
+    >>> modules()
+    ['binary_search', 'breadth_first_search', 'depth_first_search', 'linear_search']
+
 * For Searching:
-  Remember ``search()`` function takes two parameters as a sorted list and the target element to be searched.
+  Remember ``search()`` function in `binary_search` module takes two parameters as a sorted list and the target element to be searched.
 
 .. code-block:: python
 
@@ -64,3 +72,31 @@ Features
 
     # for printing the source code of bubble_sort
     print(binary_search.get_code())
+
+
+Binary Search
+-------------
+
+* Functions and their uses
+    - search(List, key)   : returns the position (index) of the key if key found, else returns -1. Note: `List` parameter **must** be sorted
+    - time_complexities() : returns time complexities (Best, Average, Worst)
+    - get_code()          : returns the code for the ``binary_search.search()`` function
+
+Linear Search
+-------------
+
+* Functions and their uses
+    - search(List, key)   : returns the position (index) of the key if key found, else returns -1
+    - time_complexities() : returns time complexities (Best, Average, Worst)
+    - get_code()          : returns the code for the ``linear_search.search()`` function
+
+Breadth First Search
+--------------------
+
+* Functions and their uses
+    - .. py:function:: search(graph, startVertex)
+                       returns the bfs for the ``graph``
+    - .. py:function:: time_complexities()
+                       returns time complexities
+    - .. py:function:: get_code()
+                       returns the code for the ``breadth_first_search.search()`` function
