Skip to content

Commit

Permalink
New params-returns format.
Browse files Browse the repository at this point in the history
  • Loading branch information
Vital-Fernandez committed May 15, 2018
1 parent c691fb6 commit bd857c6
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion doc/gumath/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
Mathematical operations
=======================

The gumath functions provide a python wrapper for the libgumath library. The operations currently available are :ref:`sine <sin>` and cosine.
The gumath functions provide a python wrapper for the libgumath library. The operations currently available are :ref:`sine <sin>` and :ref:`cosine <cos>`.

Trigonometry functions
----------------------
Expand Down
8 changes: 4 additions & 4 deletions doc/gumath/trigonometry/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@
sin
===

Trigonometric sine, element-wise. See :ref:`sine function <sin>`.
Trigonometric sine, element-wise.

:param x: `(array_like)` Angle, in radians (2*pi rad equals 360 degrees).
:param x: `(array_like)` Angle, in radians (:math:`2\pi` rad equals 360 degrees).

:returns: `(array_like)` The sine of each element of x.

Example
-------
^^^^^^^

.. doctest::

Expand All @@ -37,7 +37,7 @@ Trigonometric cosine, element-wise.
:returns: `(array_like)` The cosine of each element of x.

Example
-------
^^^^^^^

.. doctest::

Expand Down
2 changes: 1 addition & 1 deletion doc/libgumath/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This initial libgumath version displays a simple design. The goal is
to determine whether the kernel signatures and the dispatch model are suitable
for Numba.

Currently the only functions available are sine and cosine.
Currently the only functions available are :ref:`sine <sin>` and :ref:`cosine <cos>`.

.. toctree::

Expand Down

0 comments on commit bd857c6

Please sign in to comment.