Skip to content

Commit c43942c

Browse files
committed
fixes from review
1 parent 0b6760c commit c43942c

File tree

3 files changed

+6
-5
lines changed

3 files changed

+6
-5
lines changed

doc/reference.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ In addition, we recommend that reports should include information on:
5454
Reporting Template & Example
5555
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5656

57-
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.
57+
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.
5858

5959
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).
6060

examples/models/plot_aperiodic_params.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@
104104
#
105105
# This can also be seen in this animation showing this effect across different rotation points:
106106
#
107-
# ![spectralrotation](https://raw.githubusercontent.com/fooof-tools/Visualizers/main/gifs/specrot.gif "specrot")
107+
# .. image:: https://raw.githubusercontent.com/fooof-tools/Visualizers/main/gifs/specrot.gif
108108
#
109109
# Notably this means that while the offset and exponent can change independently (there can be
110110
# offset changes over and above exponent changes), the baseline expectation is that these
@@ -144,13 +144,13 @@
144144
# Knee Frequency
145145
# ~~~~~~~~~~~~~~
146146
#
147-
# You might notice that the knee _parameter_ is not an obvious value. Notably, this parameter
147+
# You might notice that the knee *parameter* is not an obvious value. Notably, this parameter
148148
# value as extracted from the model is something of an abstract quantify based on the
149149
# formalization of the underlying fit function. A more intuitive measure that we may
150150
# be interested in is the 'knee frequency', which is an estimate of the frequency value
151151
# at which the knee occurs.
152152
#
153-
# The `:func:`~.compute_knee_frequency` function can be used to compute the knee frequency.
153+
# The :func:`~.compute_knee_frequency` function can be used to compute the knee frequency.
154154
#
155155

156156
###################################################################################################
@@ -166,7 +166,7 @@
166166
# Another interesting property of the knee parameter is that it has a direct relationship
167167
# to the auto-correlation function, and from there to the empirical time constant of the data.
168168
#
169-
# The `:func:`~.compute_time_constant` function can be used to compute the knee-derived
169+
# The :func:`~.compute_time_constant` function can be used to compute the knee-derived
170170
# time constant.
171171
#
172172

tutorials/plot_09-Reporting.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@
5757
# -----------------------------------
5858
#
5959
# To assist with reporting information, the module has the following utilities:
60+
#
6061
# - the :func:`~.methods_report_info`, which prints out methods reporting information
6162
# - the :func:`~.methods_report_text`, which prints out a template of methods reporting text
6263
#

0 commit comments

Comments
 (0)