Skip to content

Commit

Permalink
DOC: fix rst structure warnings.
Browse files Browse the repository at this point in the history
  • Loading branch information
phmbressan committed Nov 17, 2023
1 parent e8191c2 commit 41cee0a
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions docs/user/function.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _functionusage::
.. _functionusage:

Function Class Usage
====================
Expand All @@ -21,8 +21,8 @@ a. Datasets

The ``Function`` class supports a wide variety of dataset sources:

- List or Numpy Array
^^^^^^^^^^^^^^^^^^^^^
List or Numpy Array
^^^^^^^^^^^^^^^^^^^

A ``list`` or ``numpy.ndarray`` of datapoints that maps input values to an output can be used as a ``Function`` source. For instance, we can define a dataset that follows the function :math:`f(x) = x^2`:

Expand Down Expand Up @@ -86,8 +86,8 @@ Two dimensional plots are also supported, therefore this data source can be plot
.. important::
The ``Function`` class only supports interpolation ``shepard`` and extrapolation ``natural`` for datasets higher than one dimension (more than one input).

- CSV File
^^^^^^^^^^
CSV File
^^^^^^^^

A CSV file path can be passed as ``string`` to the ``Function`` source. The file must contain a dataset structured so that each line is a datapoint: the last column is the output and the previous columns are the inputs.

Expand Down Expand Up @@ -141,8 +141,8 @@ A Python function that maps a set of parameters to a result can be used as a ``F

The result of this operation is a ``Function`` object that wraps the source function and features many functionalities, such as plotting.

- Constant Functions
^^^^^^^^^^^^^^^^^^^^
Constant Functions
^^^^^^^^^^^^^^^^^^

A special case of the python function source is the definition of a constant ``Function``. The class supports a convenient shortcut to ease the definition of a constant source:

Expand Down

0 comments on commit 41cee0a

Please sign in to comment.