Commit e68660b3 authored by Manuel Günther's avatar Manuel Günther

Updated documentation (slightly)

parent 67f8fc2b
......@@ -407,7 +407,7 @@ static PyGetSetDef PyBobSpQuantization_getseters[] = {
static auto s_quantize = bob::extension::FunctionDoc(
"quantize",
"Quantizes the given input",
".. todo:: Document exaxtly, what this function does, i.e., what is stored in the output array.\n\n"
".. todo:: Document exactly, what this function does, i.e., what is stored in the output array.\n\n"
".. note:: The :py:meth:`__call__`` function is a synonym for this function, turning this object into a functor.",
true
)
......
......@@ -10,10 +10,8 @@
Bob's Signal Processing Routines
==================================
.. todolist::
This module contains base functionality from Bob bound to Python, available in
the C++ counter-part ``bob::sp``. It includes core signal processing utilities.
This module contains basic signal processing functionality from Bob bound to Python, available in the C++ counter-part ``bob::sp``.
This functionality mainly includes Fast Fourier Transforms and Discrete Cosine Transforms, as well as functionality for extrapolation of 1D and 2D signals.
Documentation
-------------
......@@ -24,6 +22,13 @@ Documentation
py_api
c_cpp_api
TODO's
------
.. todolist::
Indices and tables
------------------
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment