Updated Docs

Author: OmkarPathak

docs/Data_Structure.rst

@@ -52,13 +52,27 @@ Features
     myStack = Stack()
     print(myStack.get_code())
 
-* To see all the available functions in a module there is a `modules()` function available. For example,
+* To see all the available functions in a module, you can just type ``help()`` with the module name as argument. For example,
 
 .. code:: python
 
-    >>> from pygorithm.data_structures import modules
-    >>> modules()
-    ['graph', 'heap', 'linked_list', 'queue', 'stack', 'tree']
+    >>> from pygorithm import data_structures
+    >>> help(data_structures)
+            Help on package pygorithm.data_structures in pygorithm:
+
+            NAME
+            pygorithm.data_structures
+
+            PACKAGE CONTENTS
+            graph
+            heap
+            linked_list
+            modules
+            queue
+            stack
+            tree
+    >>> from pygorithm.data_structures import graph
+    >>> help(graph)
 
 Stack
 -----

docs/Fibonacci.rst

@@ -32,13 +32,26 @@ Features
     code = fib_recursion.get_code()
     print(code)
 
-* To see all the available functions in a module there is a `modules()` function available. For example,
+* To see all the available functions in a module, you can just type ``help()`` with the module name as argument. For example,
 
 .. code:: python
 
-    >>> from pygorithm.fibonacci import modules
-    >>> modules()
-    ['generator', 'goldenratio', 'memoization', 'recursion']
+    >>> from pygorithm import fibonacci
+    >>> help(fibonacci)
+            Help on package pygorithm.fibonacci in pygorithm:
+
+            NAME
+            pygorithm.fibonacci - Collection of fibonacci methods and functions
+
+            PACKAGE CONTENTS
+            generator
+            goldenratio
+            memoization
+            modules
+            recursion
+
+    >>> from pygorithm.fibonacci import memoization
+    >>> help(memoization)
 
 Implementations API
 -------------------

docs/Math.rst

@@ -0,0 +1,72 @@
+====
+Math
+====
+
+Some of the mathematical algorithms and their implementations
+
+Quick Start Guide
+-----------------
+
+.. code-block:: python
+
+    # import the required math
+    from pygorithm.math import lcm
+
+    # find the lcm for all the elements in the list
+    ans = lcm.lcm([3, 12, 16])
+
+    #print the result
+    print(ans)
+
+Features
+--------
+
+* Algorithms available:
+    - LCM (lcm)
+    - Sieve of Eratostenes (sieve_of_eratosthenes)
+
+* To see all the available functions in a module there is a `modules()` function available. For example,
+
+.. code:: python
+
+    >>> from pygorithm.math import modules
+    >>> modules.modules()
+    ['lcm', 'sieve_of_eratosthenes']
+
+* Get the code used for any of the algorithm
+
+.. code-block:: python
+
+    from pygorithm.math import lcm
+
+    # for printing the source code of LCM function
+    print(lcm.get_code())
+
+
+LCM
+---
+
+* Functions and their uses
+
+.. function:: lcm.lcm(List)
+
+- **List**            : `list` or `array` of which LCM is to be found
+- **Return Value**    : returns the integer value of LCM
+
+.. function:: lcm.get_code()
+
+- **Return Value**    : returns the code for the ``lcm.lcm()`` function
+
+Sieve of Eratostenes
+--------------------
+
+* Functions and their uses
+
+.. function:: sieve_of_eratostenes.sieve_of_eratostenes(n)
+
+- **n**               : upper limit upto which prime numbers are to be found
+- **Return Value**    : returns the `list` of all primes upto n
+
+.. function:: sieve_of_eratostenes.get_code()
+
+- **Return Value**    : returns the code for the ``sieve_of_eratostenes.sieve_of_eratostenes()`` function

docs/Searching.rst

@@ -30,13 +30,27 @@ 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,
+* To see all the available functions in a module, you can just type ``help()`` with the module name as argument. For example,
 
 .. code:: python
 
-    >>> from pygorithm.searching import modules
-    >>> modules()
-    ['binary_search', 'breadth_first_search', 'depth_first_search', 'linear_search', 'quick_select']
+    >>> from pygorithm import searching
+    >>> help(searching)
+            Help on package pygorithm.searching in pygorithm:
+
+            NAME
+            pygorithm.searching - Collection of searching algorithms
+
+            PACKAGE CONTENTS
+            binary_search
+            breadth_first_search
+            depth_first_search
+            linear_search
+            modules
+            quick_select
+    >>> from pygorithm.searching import binary_search)
+    >>> help(binary_search)
+
 
 * For Searching:
   Remember ``search()`` function in `binary_search` module takes two parameters as a sorted list and the target element to be searched.

docs/Sorting.rst

@@ -12,45 +12,51 @@ Quick Start Guide
     # import the required sort
     from pygorithm.sorting import bubble_sort
 
-    myList = [12, 4, 2, 14, 3, 7, 5]
+    my_list = [12, 4, 2, 14, 3, 7, 5]
 
-    # to sort the list
-    sorted_list = bubble_sort.sort(myList)
+    # to sort the _list
+    sorted__list = bubble_sort.sort(my_list)
 
 Features
 --------
 
-* Sorts available:
-    - Bubble Sort (bubble_sort)
-    - Selection Sort (selection_sort)
-    - Insertion Sort (insertion_sort)
-    - Merge Sort (merge_sort)
-    - Quick Sort (quick_sort)
-    - Bucket Sort (bucket_sort)
-    - Counting Sort (counting_sort)
-    - Heap Sort (heap_sort)
-    - Shell Sort (shell_sort)
-
-* To see all the available functions in a module there is a `modules()` function available. For example,
+* To see all the available functions in a module, you can just type ``help()`` with the module name as argument. For example,
 
 .. code:: python
 
-    >>> from pygorithm.sorting import modules
-    >>> modules.modules()
-    ['bubble_sort', 'bucket_sort', 'counting_sort', 'heap_sort', 'insertion_sort', 'merge_sort', 'quick_sort', 'selection_sort', 'shell_sort']
+    >>> from pygorithm import sorting
+    >>> help(sorting)
+        Help on package pygorithm.sorting in pygorithm:
+
+        NAME
+            pygorithm.sorting - Collection of sorting methods
+
+        PACKAGE CONTENTS
+            bubble_sort
+            bucket_sort
+            counting_sort
+            heap_sort
+            insertion_sort
+            merge_sort
+            modules
+            quick_sort
+            selection_sort
+            shell_sort
+    >>> from pygorithm.sorting import bubble_sort
+    >>> help(bubble_sort)
 
 * For sorting:
-  Remember ``sort()`` function takes its parameter as a list only.
+  Remember ``sort()`` function takes its parameter as a _list only.
 
 .. code-block:: python
 
     # import the required sort
     from pygorithm.sorting import bubble_sort
 
-    myList = [12, 4, 2, 14, 3, 7, 5]
+    my_list = [12, 4, 2, 14, 3, 7, 5]
 
-    # to sort the list
-    sorted_list = bubble_sort.sort(myList)
+    # to sort the _list
+    sorted__list = bubble_sort.sort(my_list)
 
 * Get time complexities of all the sorting algorithms
 
@@ -76,9 +82,9 @@ Bubble Sort
 
 * Functions and their uses
 
-.. function:: bubble_sort.sort(List)
+.. function:: bubble_sort.sort(_list)
 
-- **List**            : `list` or `array` to be sorted
+- **_list**            : `list` or `array` to be sorted
 - **Return Value**    : returns the sorted `list`
 
 .. function:: bubble_sort.time_complexities()
@@ -91,19 +97,19 @@ Bubble Sort
 
 * For improved Bubble sort
 
-.. function:: bubble_sort.improved_sort(List)
+.. function:: bubble_sort.improved_sort(_list)
 
-- **List**            : `list` or `array` to be sorted
+- **_list**            : `list` or `array` to be sorted
 - **Return Value**    : returns the sorted `list`
 
 Bucket Sort
 -----------
 
 * Functions and their uses
 
-.. function:: bucket_sort.sort(List, bucketSize)
+.. function:: bucket_sort.sort(_list, bucketSize)
 
-- **List**            : `list` or `array` to be sorted
+- **_list**            : `list` or `array` to be sorted
 - **bucketSize**      : size of the bucket. Default is **5**
 - **Return Value**    : returns the sorted `list`
 
@@ -120,9 +126,9 @@ Counting Sort
 
 * Functions and their uses
 
-.. function:: counting_sort.sort(List)
+.. function:: counting_sort.sort(_list)
 
-- **List**            : `list` or `array` to be sorted
+- **_list**            : `list` or `array` to be sorted
 - **Return Value**    : returns the sorted `list`
 
 .. function:: counting_sort.time_complexities()
@@ -138,9 +144,9 @@ Heap Sort
 
 * Functions and their uses
 
-.. function:: heap_sort.sort(List)
+.. function:: heap_sort.sort(_list)
 
-- **List**            : `list` or `array` to be sorted
+- **_list**            : `list` or `array` to be sorted
 - **Return Value**    : returns the sorted `list`
 
 .. function:: heap_sort.time_complexities()
@@ -156,9 +162,9 @@ Insertion Sort
 
 * Functions and their uses
 
-.. function:: insertion_sort.sort(List)
+.. function:: insertion_sort.sort(_list)
 
-- **List**            : `list` or `array` to be sorted
+- **_list**            : `list` or `array` to be sorted
 - **Return Value**    : returns the sorted `list`
 
 .. function:: insertion_sort.time_complexities()
@@ -174,9 +180,9 @@ Merge Sort
 
 * Functions and their uses
 
-.. function:: merge_sort.sort(List)
+.. function:: merge_sort.sort(_list)
 
-- **List**            : `list` or `array` to be sorted
+- **_list**            : `list` or `array` to be sorted
 - **Return Value**    : returns the sorted `list`
 
 .. function:: merge_sort.time_complexities()
@@ -192,9 +198,9 @@ Quick Sort
 
 * Functions and their uses
 
-.. function:: quick_sort.sort(List)
+.. function:: quick_sort.sort(_list)
 
-- **List**            : `list` or `array` to be sorted
+- **_list**            : `list` or `array` to be sorted
 - **Return Value**    : returns the sorted `list`
 
 .. function:: quick_sort.time_complexities()
@@ -210,9 +216,9 @@ Selection Sort
 
 * Functions and their uses
 
-.. function:: selection_sort.sort(List)
+.. function:: selection_sort.sort(_list)
 
-- **List**            : `list` or `array` to be sorted
+- **_list**            : `list` or `array` to be sorted
 - **Return Value**    : returns the sorted `list`
 
 .. function:: selection_sort.time_complexities()
@@ -228,9 +234,9 @@ Shell Sort
 
 * Functions and their uses
 
-.. function:: shell_sort.sort(List)
+.. function:: shell_sort.sort(_list)
 
-- **List**            : `list` or `array` to be sorted
+- **_list**            : `list` or `array` to be sorted
 - **Return Value**    : returns the sorted `list`
 
 .. function:: shell_sort.time_complexities()

docs/index.rst

@@ -2,6 +2,9 @@
 Pygorithm
 =========
 
+Introduction
+------------
+
 ``Pygorithm``: A fun way to learn algorithms on the go! Just import the module and start learning, it's that easy.
 
 A Python module written in pure python and for purely educational purposes.
@@ -23,6 +26,7 @@ Quick Links
    Searching
    Data_Structure
    Fibonacci
+   Math
 
 Quick Start Guide
 -----------------