From c43942cd0b0d427bca5bfbb21edf129d8420fe0e Mon Sep 17 00:00:00 2001 From: Tom Donoghue Date: Thu, 20 Jul 2023 00:27:24 -0400 Subject: [PATCH] fixes from review --- doc/reference.rst | 2 +- examples/models/plot_aperiodic_params.py | 8 ++++---- tutorials/plot_09-Reporting.py | 1 + 3 files changed, 6 insertions(+), 5 deletions(-) diff --git a/doc/reference.rst b/doc/reference.rst index e347d696..24725d7e 100644 --- a/doc/reference.rst +++ b/doc/reference.rst @@ -54,7 +54,7 @@ In addition, we recommend that reports should include information on: Reporting Template & Example ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -To assist in reporting on using FOOOF, we have created some templates for reporting on spectral parameterization methods. There are also some utilities included in the code to collected the required information. +To assist in reporting on using FOOOF, we have created some templates for reporting on spectral parameterization methods. There are also some utilities included in the code to collect the required information. The following box is an example of what a methods report might look like (where all of the *X*'s should be filled in with the relevant information). diff --git a/examples/models/plot_aperiodic_params.py b/examples/models/plot_aperiodic_params.py index 9e2e0c11..96f018e4 100644 --- a/examples/models/plot_aperiodic_params.py +++ b/examples/models/plot_aperiodic_params.py @@ -104,7 +104,7 @@ # # This can also be seen in this animation showing this effect across different rotation points: # -# ![spectralrotation](https://raw.githubusercontent.com/fooof-tools/Visualizers/main/gifs/specrot.gif "specrot") +# .. image:: https://raw.githubusercontent.com/fooof-tools/Visualizers/main/gifs/specrot.gif # # Notably this means that while the offset and exponent can change independently (there can be # offset changes over and above exponent changes), the baseline expectation is that these @@ -144,13 +144,13 @@ # Knee Frequency # ~~~~~~~~~~~~~~ # -# You might notice that the knee _parameter_ is not an obvious value. Notably, this parameter +# You might notice that the knee *parameter* is not an obvious value. Notably, this parameter # value as extracted from the model is something of an abstract quantify based on the # formalization of the underlying fit function. A more intuitive measure that we may # be interested in is the 'knee frequency', which is an estimate of the frequency value # at which the knee occurs. # -# The `:func:`~.compute_knee_frequency` function can be used to compute the knee frequency. +# The :func:`~.compute_knee_frequency` function can be used to compute the knee frequency. # ################################################################################################### @@ -166,7 +166,7 @@ # Another interesting property of the knee parameter is that it has a direct relationship # to the auto-correlation function, and from there to the empirical time constant of the data. # -# The `:func:`~.compute_time_constant` function can be used to compute the knee-derived +# The :func:`~.compute_time_constant` function can be used to compute the knee-derived # time constant. # diff --git a/tutorials/plot_09-Reporting.py b/tutorials/plot_09-Reporting.py index b41f1f39..8d530da9 100644 --- a/tutorials/plot_09-Reporting.py +++ b/tutorials/plot_09-Reporting.py @@ -57,6 +57,7 @@ # ----------------------------------- # # To assist with reporting information, the module has the following utilities: +# # - the :func:`~.methods_report_info`, which prints out methods reporting information # - the :func:`~.methods_report_text`, which prints out a template of methods reporting text #