FIX typos and layout

physiopy · Aug 8, 2024 · 9b6a03c · 9b6a03c
1 parent 9312077
commit 9b6a03c
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 7 deletions.
diff --git a/README.rst b/README.rst
@@ -1,7 +1,7 @@
 phys2denoise: A toolbox for physiological metrics calculation
 =============================================================
 
-This package is designed for use in the metrics calculation of physiological data, more specifically of cardiac and respiratory signals, to be used in fMRI denoising.
+This package is designed for calculating physiological metrics, derived specifically cardiac and respiratory signals, to use in fMRI denoising.
 
 
 .. image:: https://readthedocs.org/projects/phys2denoise/badge/?version=latest

diff --git a/docs/api.rst b/docs/api.rst
@@ -5,13 +5,13 @@ API
 .. py:module:: phys2denoise
 
 Cardiac data
-------------------
+------------
 
 .. automodule:: phys2denoise.metrics.cardiac
    :members: heart_rate, heart_rate_variability, heart_beat_interval, cardiac_phase
 
 Respiratory data
-------------
+----------------
 
 .. automodule:: phys2denoise.metrics.chest_belt
    :members: respiratory_cariance_time, respiratory_pattern_variability, env, respiratory_variance, respiratory_phase
@@ -22,13 +22,13 @@ Multimodal data
 .. autofunction:: phys2denoise.multimodal.retroicor
 
 Response functions
------------
+------------------
 
 .. automodule:: phys2denoise.metrics.responses
    :members: crf, icrf, rrf
 
 Utilities
------------
+---------
 
 .. automodule:: phys2denoise.metrics.utils
    :members: print_metric_call, mirrorpad_1d, rms_envelope_1d, apply_lags, apply_function_in_sliding_window, convolve_and_rescale, export_metric
diff --git a/docs/installation.rst b/docs/installation.rst
@@ -16,8 +16,13 @@ and running the following:
 
    pip install phys2denoise
 
+.. warning::
+
+   If you encounter an ImportError related to numpy.core.multiarray, please try to update 
+   your matplotlib version to 3.9.
+
 Developer installation
---------------------
+----------------------
 
 This package requires Python >= 3.6. Assuming you have the correct version of
 Python installed, you can install ``phys2denoise`` by opening a terminal and running

diff --git a/docs/user_guide/metrics.rst b/docs/user_guide/metrics.rst
@@ -64,7 +64,7 @@ For further information refer to the :py:mod:`physutils` documentation.
 Without using a Physio object
 #############################
 
-However, if the use of the ``Physio`` object of the :py:mod:`physutils` module is not preferred, the metrics can be also computed without it. The following
+However, if the use of the ``Physio`` object from the :py:mod:`physutils` module is not preferred, the metrics can be also computed without it. The following
 example shows how to compute the heart rate and the heart rate variability using the :py:mod:`phys2denoise` package.
 
 .. code-block:: python