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 bd857c6 commit ecf03c8
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 8 deletions.
2 changes: 1 addition & 1 deletion doc/gumath/trigonometry/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ sin

Trigonometric sine, element-wise.

:param x: `(array_like)` Angle, in radians (:math:`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.

Expand Down
11 changes: 4 additions & 7 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,23 +15,20 @@ structure or a Numpy-like container with a composable, generalized function conc
Installation
============

To run gumathn `xnd`_ and `ndtypes`_, your computer requires a Python interpreters, either version 2.7 or superior.
To run gumathn `xnd <http://xnd.readthedocs.io>`_ and `ndtypes <http://ndtypes.readthedocs.io>`_, your computer requires
a Python interpreters, either version 2.7 or superior.

gumath can be installed using `pip`_::
gumath can be installed using `pip <http://pypi.python.org/pypi/pip>`_:

python3 -m pip install gumath

Or using `anaconda`_ package manager::
Or using `anaconda <https://www.anaconda.com/download/#linux>`_ package manager:

conda install -c xnd/label/dev gumath

gumath does not depend on third-party Python except for `xnd`_ and `ndtypes`_ (currently, these packages do not have any
external dependensives themselves).

.. _xnd: https://github.com/plures/xnd
.. _ndtypes: https://github.com/plures/ndtypes
.. _pip: https://pip.pypa.io/en/latest/installing

Index
=====

Expand Down

0 comments on commit ecf03c8

Please sign in to comment.