Skip to content

Commit

Permalink
fixes some small issues in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
CSchoel committed Aug 6, 2024
1 parent 2943384 commit f57970d
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@

# General information about the project.
project = 'Nolds'
copyright = u'2016-2018, Christopher Schölzel'
copyright = u'2016-2024, Christopher Schölzel'
author = u'Christopher Schölzel'

# The version info for the project you're documenting, acts as replacement for
Expand Down Expand Up @@ -292,4 +292,4 @@
# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False

autodoc_mock_imports = ['numpy', 'future', 'setuptools', 'builtins']
# autodoc_mock_imports = ['numpy', 'future', 'setuptools', 'builtins']
2 changes: 1 addition & 1 deletion doc/source/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ You can run some examples for the functions in nolds with the command
These tests are also available as functions inside the module ``nolds.examples``.

Functions in ``nolds.examples``
-----------------------------
-------------------------------

.. autofunction:: nolds.examples.plot_lyap
.. autofunction:: nolds.examples.profiling
Expand Down
2 changes: 1 addition & 1 deletion doc/source/nolds.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Generalized Hurst Exponent (Barabási et al.)

Generalized Hurst Exponent (Di Matteo et al.)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autofunction:: nolds.mfhurst_da
.. autofunction:: nolds.mfhurst_dm

Helper functions
-----------------
Expand Down
4 changes: 2 additions & 2 deletions nolds/measures.py
Original file line number Diff line number Diff line change
Expand Up @@ -1716,7 +1716,7 @@ def mfhurst_dm(data, qvals=None, max_dists=range(5, 20), detrend=True,
a more natural fit. If low values of d yield statistically unstable
results, they should simply be omitted.
- The algorithm tests multiple values for tau_max, which is the maximum
distance that will be calculated. In [mdh]_ the authors state that this
distance that will be calculated. In [mhd_1]_ the authors state that this
is done to test the robustness of the approach. However, taking the
mean of several runs with different tau_max will not produce any more
information than performing one run with the largest tau_max. Instead
Expand All @@ -1728,7 +1728,7 @@ def mfhurst_dm(data, qvals=None, max_dists=range(5, 20), detrend=True,
and its Applications, vol. 324, no. 1–2, pp. 183–188, 2003.
Reference code:
.. [mdh_a] Tomaso Aste, "Generalized Hurst exponent",
.. [mhd_a] Tomaso Aste, "Generalized Hurst exponent",
url: http://de.mathworks.com/matlabcentral/fileexchange/30076-generalized-hurst-exponent
Args:
Expand Down

0 comments on commit f57970d

Please sign in to comment.