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 86d40b3 commit c691fb6
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 38 deletions.
3 changes: 1 addition & 2 deletions doc/gumath/index.rst
Expand Up @@ -9,8 +9,7 @@
Mathematical operations
=======================

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

Trigonometry functions
----------------------
Expand Down
43 changes: 7 additions & 36 deletions doc/gumath/trigonometry/index.rst
Expand Up @@ -5,32 +5,15 @@

.. sectionauthor:: Vital Fernandez <vital-fernandez at gmail.com>

.. _sin-reference-label:
.. _sin:
sin
===

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

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

:returns: Angle in radians (2*pi rad equals 360 degrees)

Parameters
----------

Atributes
^^^^^^^^^

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

Returns
^^^^^^^

y: array_like
The sine of each element of x.

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

Example
-------
Expand All @@ -43,27 +26,15 @@ Example
>>> gm.sin(xnd(x))
xnd([0.0, 0.70710, 0.99999], type='3 * float64')

.. _cos:
cos
===

Trigonometric cosine, element-wise.

Parameters
----------

Atributes
^^^^^^^^^

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

Returns
^^^^^^^

y: array_like
The cosine of each element of x.
:param x: `(array_like)` Angle, in radians (2*pi rad equals 360 degrees).

returns: array:like
:returns: `(array_like)` The cosine of each element of x.

Example
-------
Expand Down

0 comments on commit c691fb6

Please sign in to comment.