Skip to content

Commit 0fd77d0

Browse files
committed
Updated README
1 parent 0ca5ef8 commit 0fd77d0

File tree

1 file changed

+24
-6
lines changed

1 file changed

+24
-6
lines changed

README.rst

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
=========
1+
22
Pygorithm
33
=========
44

@@ -70,14 +70,32 @@ Quick Start Guide
7070
time_complexity = bubble_sort.time_complexities()
7171
print(time_complexity)
7272
73-
* To see all the available functions in a module. For example, if you want to see what all sorts are available in the sorting module, then just do
73+
* To see all the available functions in a module, you can just type ``help()`` with the module name as argument. For example,
7474

7575
.. code:: python
7676
77-
>>> from pygorithm.sorting import modules
78-
>>> modules()
79-
['bubble_sort', 'bucket_sort', 'counting_sort', 'heap_sort', 'insertion_sort', 'merge_sort', 'quick_sort', 'selection_sort', 'shell_sort']
80-
77+
>>> from pygorithm import sorting
78+
>>> help(sorting)
79+
Help on package pygorithm.sorting in pygorithm:
80+
81+
NAME
82+
pygorithm.sorting - Collection of sorting methods
83+
84+
PACKAGE CONTENTS
85+
bubble_sort
86+
bucket_sort
87+
counting_sort
88+
heap_sort
89+
insertion_sort
90+
merge_sort
91+
modules
92+
quick_sort
93+
selection_sort
94+
shell_sort
95+
>>> from pygorithm.sorting import bubble_sort
96+
>>> help(bubble_sort)
97+
98+
8199
Tests
82100
~~~~~
83101

0 commit comments

Comments
 (0)