GoulagSort/docs/source/using_goulag_sort.rst

63 lines
1.3 KiB
ReStructuredText

Using Goulag Sort
######################
First and foremost:
:bigText:`WHY???????`
Goulag Sort is not meant to be quick or useful, it is really slow and inefficient.
But if after this warning you wanna use you can...(I ain't your mother)
Installing the Library
=======================================
The Library is available to use using pip but is not available on PyPI
Why is not available on PyPI
+++++++++++++++++++++++++++++
This sorting algorithm is extremely bad and is not meant to be taken seriously, so its not fair to be uploaded.
Installing Via git
=========================
.. code-block:: bash
pip install git+https://git.gustavomiranda.xyz/GHMiranda/GoulagSort.git
Using the Library
==============================
To use the library firstly you need to import:
.. code-block:: python
from goulag_sort import send_to_goulag
after importing you can call the ``send_to_goulag()`` function
.. code-block:: python
>>> from goulag_sort import send_to_goulag
>>> unordered_list = [80,64,14,25,98,1,74,13,10,5]
>>> print(unordered_list)
[80,64,14,25,98,1,74,13,10,5]
>>> send_to_goulag(unordered_list)
>>> print(unordered_list)
[1,5,10,13,14,25,64,74,80,98]
to see the function documentation please refer to:
:ref:`goulag_sort_package_reference`