Skip to content

Commit aea1983

Browse files
authored
Merge pull request #404 from blalterman/fix/doc8-linting-errors
fix(docs): resolve doc8 linting errors in documentation
2 parents 6772a0c + 8d6a8ba commit aea1983

2 files changed

Lines changed: 12 additions & 9 deletions

File tree

docs/source/_templates/autosummary/module.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,10 @@
5959
.. autosummary::
6060
:toctree:
6161
:recursive:
62+
6263
{% for item in modules %}
6364
{{ item }}
64-
{%- endfor %}
65+
{%- endfor %}
66+
6567
{% endif %}
6668
{% endblock %}

docs/source/usage.rst

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ The Plasma class is structured to intelligently combine observations from across
151151
beta = plasma.beta('p1+a')
152152
# Both betas
153153
beta = plasma.beta('a,p1')
154-
154+
155155
156156
Data Visualization
157157
------------------
@@ -220,13 +220,14 @@ Create a 2D histogram using SolarWindPy aggregation tools:
220220
221221
# Create a 2D histogram of the data
222222
from solarwindpy.plotting import Hist2D
223-
223+
224224
beta = plasma.beta('p1').xs('par', axis=1, level='S')
225225
h2d = Hist2D(vx, beta, nbins=(50, 50), logy=True) # calculate log-scaled y-bins
226226
h2d.set_labels(x=xlbl, y=TeXlabel('beta', 'par', 'p1'))
227227
h2d.make_plot()
228228
229-
SolarWindPy plotting tools have built-in path management that includes axis scales and plot normalizations:
229+
SolarWindPy plotting tools have built-in path management that includes axis
230+
scales and plot normalizations:
230231

231232
.. code-block:: pycon
232233
@@ -240,7 +241,7 @@ The path updates when you change normalization:
240241
>>> h2d.set_axnorm('c') # Make the plot column-normalized
241242
>>> h2d.path
242243
Path('Hist2D/v_x_p1/beta_par_p1/linX-logY/Cnorm')
243-
244+
244245
Show all available labels:
245246

246247
.. code-block:: pycon
@@ -280,23 +281,23 @@ For more complex analyses:
280281
281282
# Get thermal speed data
282283
w_par = plasma.w('p1').xs('par', level='C')
283-
284+
284285
# Histogram data
285286
from solarwindpy.plotting import Hist1D
286287
h1d = Hist1D(w_par, nbins=50)
287288
h1d.set_labels(x=TeXlabel(('w', 'par', 'p1')))
288-
289+
289290
# Get aggregated data
290291
agg = h1d.agg()
291-
292+
292293
# Aggregated index is an IntervalIndex, but was previously monkey patched to address
293294
# a pandas pretty printing bug.
294295
x_data = pd.IntervalIndex(agg.index).mid
295296
y_data = agg.values
296297
297298
fit = Gaussian(x_data, y_data)
298299
fit.make_fit()
299-
300+
300301
# Plot the resulting fit
301302
fit.plotter.set_labels(x=TeXlabel(('w', 'par', 'p1')))
302303
fit.plotter.plot_raw_used_fit_resid()

0 commit comments

Comments
 (0)