Skip to content

Commit

Permalink
Fix formating on readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mthh committed Aug 18, 2022
1 parent d41af3f commit c8b64d4
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Wheels are provided via PyPI for Windows / MacOS / Linux users - Also available
Usage
-----

This package consists of a single function (named ``jenks_breaks``) which takes as input a ``list <https://docs.python.org/3/library/stdtypes.html#list>``_ / ``tuple <https://docs.python.org/3/library/stdtypes.html#tuple>``_ / ``array.array <https://docs.python.org/3/library/array.html#array.array>``_ / ``numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>``_ of integers or floats.
This package consists of a single function (named ``jenks_breaks``) which takes as input a `list <https://docs.python.org/3/library/stdtypes.html#list>`_ / `tuple <https://docs.python.org/3/library/stdtypes.html#tuple>`_ / `array.array <https://docs.python.org/3/library/array.html#array.array>`_ / `numpy.ndarray <https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html>`_ of integers or floats.
It returns a list of values that correspond to the limits of the classes (starting with the minimum value of the series - the lower bound of the first class - and ending with its maximum value - the upper bound of the last class).


Expand Down Expand Up @@ -110,13 +110,13 @@ Installation
Requirements :
----------------------------------------------

- NumPy\ :sup:``*``
- C compiler\ :sup:``+``
- Python C headers\ :sup:``+``
- NumPy\ :sup:`*`
- C compiler\ :sup:`+`
- Python C headers\ :sup:`+`

\ :sup:``*`` only for using ``JenksNaturalBreaks`` interface
\ :sup:`*` only for using ``JenksNaturalBreaks`` interface

\ :sup:``+`` only for building from source
\ :sup:`+` only for building from source

Motivation :
------------
Expand Down

0 comments on commit c8b64d4

Please sign in to comment.